Debian Codegraph @

docs/dyn/compute_v1.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_v1.html">Compute Engine API</a> . <a href="compute_v1.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/v1/globalOperations)
190 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
191 # * [Zonal](/compute/docs/reference/rest/v1/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/v1/backendServices)
578 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/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;trafficDuration&quot;: &quot;A String&quot;,
713 },
714 ],
715 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
716 # specified load balancer types.
717 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
718 # Pragma or Authorization headers. Up to 5 headers can be specified.
719 # The cache is bypassed for all cdnPolicy.cacheMode settings.
720 { # Bypass the cache when the specified request headers are present,
721 # e.g. Pragma or Authorization headers. Values are case insensitive.
722 # The presence of such a header overrides the cache_mode setting.
723 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
724 # Values are case-insensitive.
725 },
726 ],
727 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
728 # CDN.
729 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
730 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
731 &quot;A String&quot;,
732 ],
733 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
734 # The name=value pair will be used in the cache key Cloud CDN generates.
735 &quot;A String&quot;,
736 ],
737 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
738 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
739 # query_string_whitelist and query_string_blacklist. If neither is set, the
740 # entire query string will be included. If false, the query string will be
741 # excluded from the cache key entirely.
742 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
743 # parameters will be included. Either specify query_string_whitelist or
744 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
745 # not treated as delimiters.
746 &quot;A String&quot;,
747 ],
748 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
749 # parameters will be excluded. Either specify query_string_whitelist or
750 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
751 # not treated as delimiters.
752 &quot;A String&quot;,
753 ],
754 },
755 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
756 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
757 # headers to cache content. Responses without these headers will not be
758 # cached at Google&#x27;s edge, and will require a full trip to the origin on
759 # every request, potentially impacting performance and increasing load on
760 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
761 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
762 # Warning: this may result in Cloud CDN caching private,
763 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
764 # including common image formats, media (video and audio), and web assets
765 # (JavaScript and CSS). Requests and responses that are marked as
766 # uncacheable, as well as dynamic content (including HTML), will not be
767 # cached.
768 #
769 # If no value is provided for cdnPolicy.cacheMode, it defaults
770 # to CACHE_ALL_STATIC.
771 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
772 # used to clamp the max-age (or Expires) value sent to the client. With
773 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
774 # response max-age directive, along with a &quot;public&quot; directive. For
775 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
776 # from the origin (if specified), or else sets the response max-age
777 # directive to the lesser of the client_ttl and default_ttl, and also
778 # ensures a &quot;public&quot; cache-control directive is present.
779 # If a client TTL is not specified, a default value (1 hour) will be used.
780 # The maximum allowed value is 31,622,400s (1 year).
781 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
782 # responses that do not have an existing valid TTL (max-age or s-maxage).
783 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
784 # The value of defaultTTL cannot be set to a value greater than that of
785 # maxTTL, but can be equal.
786 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
787 # will overwrite the TTL set in all responses. The maximum allowed value is
788 # 31,622,400s (1 year), noting that infrequently accessed objects may be
789 # evicted from the cache before the defined TTL.
790 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
791 # origin.
792 # Cache directives that attempt to set a max-age or s-maxage higher than
793 # this, or an Expires header more than maxTTL seconds in the future will
794 # be capped at the value of maxTTL, as if it were the value of an
795 # s-maxage Cache-Control directive.
796 # Headers sent to the client will not be modified.
797 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
798 # The maximum allowed value is 31,622,400s (1 year), noting that
799 # infrequently accessed objects may be evicted from the cache before
800 # the defined TTL.
801 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
802 # to apply fine-grained caching for common errors or redirects.
803 # This can reduce the load on your origin and improve end-user
804 # experience by reducing response latency.
805 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
806 # negative caching applies to responses with the specified response code
807 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
808 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
809 # to all responses with the specified response code, and override any
810 # caching headers.
811 # By default, Cloud CDN will apply the following default TTLs to these
812 # status codes:
813 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
814 # HTTP 404 (Not Found), 410 (Gone),
815 # 451 (Unavailable For Legal Reasons): 120s
816 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
817 # These defaults can be overridden in negative_caching_policy.
818 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
819 # negative_caching must be enabled to configure negative_caching_policy.
820 # Omitting the policy and leaving negative_caching enabled will use
821 # Cloud CDN&#x27;s default cache TTLs.
822 # Note that when specifying an explicit negative_caching_policy, you
823 # should take care to specify a cache TTL for all response codes
824 # that you wish to cache. Cloud CDN will not apply any default
825 # negative caching when a policy exists.
826 { # Specify CDN TTLs for response error codes.
827 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
828 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
829 # specified as values, and you cannot specify a status code more than
830 # once.
831 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
832 # corresponding status code.
833 # The maximum allowed value is 1800s (30 minutes), noting that
834 # infrequently accessed objects may be evicted from the cache before the
835 # defined TTL.
836 },
837 ],
838 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
839 # requests into a small number of requests to the origin.
840 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
841 # content with the origin, or when an error is encountered when refreshing
842 # the cache.
843 # This setting defines the default &quot;max-stale&quot; duration for any cached
844 # responses that do not specify a max-stale directive. Stale responses that
845 # exceed the TTL configured here will not be served. The default limit
846 # (max-stale) is 86400s (1 day), which will allow stale content to be
847 # served up to this limit beyond the max-age (or s-maxage) of a cached
848 # response.
849 # The maximum allowed value is 604800 (1 week).
850 # Set this to zero (0) to disable serve-while-stale.
851 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
852 # considered fresh. After this time period, the response will be
853 # revalidated before being served. Defaults to 1hr (3600s). When serving
854 # responses to signed URL requests, Cloud CDN will internally behave as
855 # though all responses from this backend had a &quot;Cache-Control:
856 # public, max-age=[TTL]&quot; header, regardless of any existing
857 # Cache-Control header. The actual headers served in responses will not be
858 # altered.
859 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
860 &quot;A String&quot;,
861 ],
862 },
863 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
864 # backend service.
865 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
866 # there is no limit.
867 #
868 # Not supported when the backend service is referenced by a URL map that is
869 # bound to target gRPC proxy that has validateForProxyless field set to true.
870 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
871 # not specified, there is no limit.
872 #
873 # Not supported when the backend service is referenced by a URL map that is
874 # bound to target gRPC proxy that has validateForProxyless field set to true.
875 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
876 # service. If not specified, there is no limit.
877 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
878 # This parameter is respected by both the HTTP/1.1 and HTTP/2
879 # implementations. If not specified, there is no limit. Setting this
880 # parameter to 1 will effectively disable keep alive.
881 #
882 # Not supported when the backend service is referenced by a URL map that is
883 # bound to target gRPC proxy that has validateForProxyless field set to true.
884 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
885 # not specified, the default is 1.
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 },
890 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
891 # the client&#x27;s Accept-Encoding header.
892 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
893 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
894 # instance. For supported load balancers and protocols, as described inEnabling
895 # connection draining.
896 },
897 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
898 # tracking policy settings are only available for external passthrough
899 # Network Load Balancers and internal passthrough Network Load Balancers.
900 #
901 # connectionTrackingPolicy cannot be specified with haPolicy.
902 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
903 # value is DEFAULT_FOR_PROTOCOL.
904 #
905 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
906 # persist on unhealthy backends only for connection-oriented protocols
907 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
908 # Affinity is configured for 5-tuple. They do not persist forUDP.
909 #
910 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
911 # the existing connections on the unhealthy backend are never persisted on
912 # the unhealthy backend. They are always diverted to newly selected healthy
913 # backends (unless all backends are unhealthy).
914 #
915 # If set to ALWAYS_PERSIST, existing connections always
916 # persist on unhealthy backends regardless of protocol and session
917 # affinity. It is generally not recommended to use this mode overriding the
918 # default.
919 #
920 # For more details, see [Connection Persistence for Network Load
921 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
922 # and [Connection Persistence for Internal TCP/UDP Load
923 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
924 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
925 # Balancers. This option is not available publicly.
926 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
927 # matching traffic (in seconds).
928 #
929 # For internal passthrough Network Load Balancers:
930 #
931 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
932 # - It can be set only if Connection Tracking is less than 5-tuple
933 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
934 # Mode is PER_SESSION).
935 #
936 #
937 #
938 # For external passthrough Network Load Balancers the default is 60
939 # seconds. This option is not available publicly.
940 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
941 # options:
942 #
943 # - PER_CONNECTION: This is the default mode. The Connection
944 # Tracking is performed as per the Connection Key (default Hash Method) for
945 # the specific protocol.
946 # - PER_SESSION: The Connection Tracking is performed as per
947 # the configured Session Affinity. It matches the configured Session
948 # Affinity.
949 #
950 #
951 #
952 # For more details, see [Tracking Mode for Network Load
953 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
954 # and [Tracking Mode for Internal TCP/UDP Load
955 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
956 },
957 &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
958 # affinity based on HTTP headers, cookies or other properties. This load
959 # balancing policy is applicable only for HTTP connections. The affinity to a
960 # particular destination host will be lost when one or more hosts are
961 # added/removed from the destination service. This field specifies parameters
962 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
963 #
964 # This field is applicable to either:
965 #
966 # - A regional backend service with the service protocol set to HTTP,
967 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
968 # INTERNAL_MANAGED.
969 # - A global backend service with the
970 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
971 &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
972 # be used as the hash key for the consistent hash load balancer. If the
973 # cookie is not present, it will be generated. This field is applicable if
974 # the sessionAffinity is set to HTTP_COOKIE.
975 #
976 # Not supported when the backend service is referenced by a URL map that is
977 # bound to target gRPC proxy that has validateForProxyless field set to true.
978 # for load balancing policies that use a consistent hash.
979 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
980 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
981 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
982 # as a count of seconds and fractions of seconds at nanosecond
983 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
984 # or &quot;month&quot;. Range is approximately 10,000 years.
985 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
986 # Durations less than one second are represented with a 0
987 # `seconds` field and a positive `nanos` field. Must be from 0
988 # to 999,999,999 inclusive.
989 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
990 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
991 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
992 },
993 },
994 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
995 # applicable if the sessionAffinity is set toHEADER_FIELD.
996 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
997 # 1024. Larger ring sizes result in more granular load distributions. If the
998 # number of hosts in the load balancing pool is larger than the ring size,
999 # each host will be assigned a single virtual node.
1000 },
1001 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1002 # text format.
1003 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
1004 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
1005 # locality_lb_policy.
1006 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
1007 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
1008 # long and match the regular expression
1009 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
1010 # first character must be a lowercase letter, and all following
1011 # characters must be a dash, period, underscore, lowercase letter, or
1012 # digit, except the last character, which cannot be a dash, period, or
1013 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
1014 # field can only be used for a global or regional backend service with the
1015 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
1016 },
1017 ],
1018 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
1019 # custom
1020 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
1021 &quot;A String&quot;,
1022 ],
1023 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
1024 # custom
1025 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
1026 &quot;A String&quot;,
1027 ],
1028 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1029 # create the resource.
1030 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
1031 # this backend service.
1032 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
1033 # global external Application Load Balancer.
1034 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
1035 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
1036 #
1037 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
1038 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
1039 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
1040 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
1041 # externalManagedMigrationTestingPercentage.
1042 #
1043 # Rolling back a migration requires the states to be set in reverse order. So
1044 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
1045 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
1046 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
1047 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
1048 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
1049 # external Application Load Balancer.
1050 #
1051 # The value of this field must be in the range [0, 100].
1052 #
1053 # Session affinity options will slightly affect this routing behavior, for
1054 # more details, see:Session
1055 # Affinity.
1056 #
1057 # This value can only be set if the loadBalancingScheme in the BackendService
1058 # is set to EXTERNAL (when using the classic Application Load Balancer) and
1059 # the migration state is TEST_BY_PERCENTAGE.
1060 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
1061 # as a backup (failover) backend.
1062 # For load balancers that have configurable failover:
1063 # [Internal passthrough Network Load
1064 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
1065 # and [external passthrough Network Load
1066 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
1067 #
1068 # failoverPolicy cannot be specified with haPolicy.
1069 # failover:
1070 # [Internal passthrough Network Load
1071 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
1072 # and [external passthrough
1073 # Network Load
1074 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
1075 # On failover or failback, this field indicates whether connection draining
1076 # will be honored. Google Cloud has a fixed connection draining timeout of
1077 # 10 minutes. A setting of true terminates existing TCP
1078 # connections to the active pool during failover and failback, immediately
1079 # draining traffic. A setting of false allows existing TCP
1080 # connections to persist, even on VMs no longer in the active pool, for up
1081 # to the duration of the connection draining timeout (10 minutes).
1082 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
1083 #
1084 # The default is false.
1085 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
1086 # load balancer are dropped when all primary and all backup backend VMs are
1087 # unhealthy.If set to false, connections are distributed
1088 # among all primary VMs when all primary and all backup backend VMs are
1089 # unhealthy.
1090 # For load balancers that have configurable
1091 # failover:
1092 # [Internal passthrough
1093 # Network Load
1094 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
1095 # and [external passthrough
1096 # Network Load
1097 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
1098 # The default is false.
1099 &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
1100 # failover when the number of healthy primary VMs equals zero.
1101 # For all other values, the load balancer performs a failover when the
1102 # total number of healthy primary VMs is less than this ratio.
1103 # For load balancers that have configurable
1104 # failover:
1105 # [Internal TCP/UDP Load
1106 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
1107 # and [external TCP/UDP Load
1108 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
1109 },
1110 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
1111 # This field is used in optimistic locking. This field will be ignored when
1112 # inserting a BackendService. An up-to-date fingerprint must be provided in
1113 # order to update the BackendService, otherwise the request will
1114 # fail with error 412 conditionNotMet.
1115 #
1116 # To see the latest fingerprint, make a get() request to
1117 # retrieve a BackendService.
1118 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
1119 # Protocol Forwarding.
1120 #
1121 # The backends of this regional backend service must only specify zonal
1122 # network endpoint groups (NEGs) of type GCE_VM_IP.
1123 #
1124 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
1125 # regional backend service must set the network field. All zonal NEGs must
1126 # belong to the same network. However, individual NEGs can
1127 # belong to different subnetworks of that network.
1128 #
1129 # When haPolicy is specified, the set of attached network endpoints across
1130 # all backends comprise an High Availability domain from which one endpoint
1131 # is selected as the active endpoint (the leader) that receives all
1132 # traffic.
1133 #
1134 # haPolicy can be added only at backend service creation time. Once set up,
1135 # it cannot be deleted.
1136 #
1137 # Note that haPolicy is not for load balancing, and therefore cannot be
1138 # specified with sessionAffinity, connectionTrackingPolicy, and
1139 # failoverPolicy.
1140 #
1141 # haPolicy requires customers to be responsible for tracking backend
1142 # endpoint health and electing a leader among the healthy endpoints.
1143 # Therefore, haPolicy cannot be specified with healthChecks.
1144 #
1145 # haPolicy can only be specified for External Passthrough Network Load
1146 # Balancers and Internal Passthrough Network Load Balancers.
1147 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
1148 # achieve it.
1149 #
1150 # Supported values are:
1151 #
1152 # - DISABLED: Fast IP Move is disabled. You can only use the
1153 # haPolicy.leader API to update the leader.
1154 # - &gt;GARP_RA: Provides a method to very quickly define a new network
1155 # endpoint as the leader. This method is faster than updating the leader
1156 # using the haPolicy.leader API. Fast IP move works as follows: The VM
1157 # hosting the network endpoint that should become the new leader sends
1158 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
1159 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
1160 # temporarily associates the forwarding rule IP address with that VM, and
1161 # both new and in-flight packets are quickly delivered to that VM.
1162 #
1163 #
1164 #
1165 # Note the important properties of the Fast IP Move functionality:
1166 #
1167 # - The GARP/RA-initiated re-routing stays active for approximately 20
1168 # minutes. After triggering fast failover, you must also
1169 # appropriately set the haPolicy.leader.
1170 # - The new leader instance should continue to send GARP/RA packets
1171 # periodically every 10 seconds until at least 10 minutes after updating
1172 # the haPolicy.leader (but stop immediately if it is no longer the leader).
1173 # - After triggering a fast failover, we recommend that you wait at least
1174 # 3 seconds before sending another GARP/RA packet from a different VM
1175 # instance to avoid race conditions.
1176 # - Don&#x27;t send GARP/RA packets from different VM
1177 # instances at the same time. If multiple instances continue to send
1178 # GARP/RA packets, traffic might be routed to different destinations in an
1179 # alternating order. This condition ceases when a single instance
1180 # issues a GARP/RA packet.
1181 # - The GARP/RA request always takes priority over the leader API.
1182 # Using the haPolicy.leader API to change the leader to a different
1183 # instance will have no effect until the GARP/RA request becomes
1184 # inactive.
1185 # - The GARP/RA packets should follow the GARP/RA
1186 # Packet Specifications..
1187 # - When multiple forwarding rules refer to a regional backend service,
1188 # you need only send a GARP or RA packet for a single forwarding rule
1189 # virtual IP. The virtual IPs for all forwarding rules targeting the same
1190 # backend service will also be moved to the sender of the GARP or RA
1191 # packet.
1192 #
1193 #
1194 #
1195 # The following are the Fast IP Move limitations (that is, when fastIPMove
1196 # is not DISABLED):
1197 #
1198 # - Multiple forwarding rules cannot use the same IP address if one of
1199 # them refers to a regional backend service with fastIPMove.
1200 # - The regional backend service must set the network field, and all
1201 # NEGs must belong to that network. However, individual
1202 # NEGs can belong to different subnetworks of that network.
1203 # - The maximum number of network endpoints across all backends of a
1204 # backend service with fastIPMove is 32.
1205 # - The maximum number of backend services with fastIPMove that can have
1206 # the same network endpoint attached to one of its backends is 64.
1207 # - The maximum number of backend services with fastIPMove in a VPC in a
1208 # region is 64.
1209 # - The network endpoints that are attached to a backend of a backend
1210 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
1211 # - Traffic directed to the leader by a static route next hop will not be
1212 # redirected to a new leader by fast failover. Such traffic will only be
1213 # redirected once an haPolicy.leader update has taken effect. Only traffic
1214 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
1215 # fast failover.
1216 #
1217 #
1218 # haPolicy.fastIPMove can be set only at backend service creation time.
1219 # Once set, it cannot be updated.
1220 #
1221 # By default, fastIpMove is set to DISABLED.
1222 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
1223 # this service as the active endpoint (the leader) that receives all
1224 # traffic.
1225 #
1226 # When the leader changes, there is no connection draining to persist
1227 # existing connections on the old leader.
1228 #
1229 # You are responsible for selecting a suitable endpoint as the
1230 # leader. For example, preferring a healthy endpoint over unhealthy ones.
1231 # Note that this service does not track backend endpoint health, and
1232 # selects the configured leader unconditionally.
1233 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
1234 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
1235 # that the leader is attached to.
1236 #
1237 # The leader&#x27;s backendGroup must already be specified as a backend of
1238 # this backend service. Removing a backend that is designated as the
1239 # leader&#x27;s backendGroup is not permitted.
1240 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
1241 # designated as the leader.
1242 #
1243 # This network endpoint cannot be detached from the NEG specified in
1244 # the haPolicy.leader.backendGroup until the leader is updated with
1245 # another network endpoint, or the leader is removed from the haPolicy.
1246 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
1247 # instance must already be attached to the NEG specified in the
1248 # haPolicy.leader.backendGroup.
1249 #
1250 # The name must be 1-63 characters long, and comply with RFC1035.
1251 # Authorization requires the following IAM permission on the
1252 # specified resource instance: compute.instances.use
1253 },
1254 },
1255 },
1256 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
1257 # httpsHealthChecks (legacy) resource for health checking this backend
1258 # service. Not all backend services support legacy health checks. See
1259 # Load balancer guide. Currently, at most one health check can be
1260 # specified for each backend service. Backend services with
1261 # instance group or zonal NEG backends must have a health check unless
1262 # haPolicy is specified. Backend services with internet or serverless NEG
1263 # backends must not have a health check.
1264 #
1265 # healthChecks[] cannot be specified with haPolicy.
1266 &quot;A String&quot;,
1267 ],
1268 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
1269 # Not available for internal passthrough Network Load Balancers and external
1270 # passthrough Network Load Balancers.
1271 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
1272 # incoming requests.
1273 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
1274 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
1275 # For security reasons, this value cannot be retrieved via the API.
1276 # Instead, the SHA-256 hash of the value is returned in the
1277 # oauth2ClientSecretSha256 field.
1278 #
1279 # @InputOnly
1280 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
1281 },
1282 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
1283 # defined by the server.
1284 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
1285 # from the client to the backend for proxyless gRPC).
1286 # The possible values are:
1287 #
1288 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
1289 # backend service (Instance Group, Managed Instance Group, Network Endpoint
1290 # Group), regardless of traffic from the client to the proxy. Only IPv4
1291 # health checks are used to check the health of the backends. This is the
1292 # default setting.
1293 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
1294 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
1295 # address).
1296 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
1297 # backend service (Instance Group, Managed Instance Group, Network Endpoint
1298 # Group), regardless of traffic from the client to the proxy. Only IPv6
1299 # health checks are used to check the health of the backends.
1300 #
1301 #
1302 #
1303 # This field is applicable to either:
1304 #
1305 # - Advanced global external Application Load Balancer (load balancing
1306 # scheme EXTERNAL_MANAGED),
1307 # - Regional external Application Load
1308 # Balancer,
1309 # - Internal proxy Network Load Balancer (load balancing
1310 # scheme INTERNAL_MANAGED),
1311 # - Regional internal Application Load
1312 # Balancer (load balancing scheme INTERNAL_MANAGED),
1313 # - Traffic
1314 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
1315 # INTERNAL_SELF_MANAGED).
1316 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
1317 # for backend services.
1318 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
1319 # created for one type of load balancer cannot be used with another.
1320 # For more information, refer toChoosing
1321 # a load balancer.
1322 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
1323 # preference. When you use localityLbPolicies, you must set at least one
1324 # value for either the localityLbPolicies[].policy or the
1325 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
1326 # value set in the localityLbPolicy field.
1327 #
1328 # For an example of how to use this field, seeDefine
1329 # a list of preferred policies.
1330 #
1331 # Caution: This field and its children are intended for use in a service mesh
1332 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
1333 # that have this configuration.
1334 { # Container for either a built-in LB policy supported by gRPC or Envoy or
1335 # a custom one implemented by the end user.
1336 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
1337 # deployed with the client.
1338 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
1339 # by a locally installed custom policy implementation.
1340 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
1341 #
1342 # The value should match the name of a custom implementation registered
1343 # on the gRPC clients. It should follow protocol buffer message naming
1344 # conventions and include the full path (for example,
1345 # myorg.CustomLbPolicy). The maximum length is 256 characters.
1346 #
1347 # Do not specify the same custom policy more than once for a
1348 # backend. If you do, the configuration is rejected.
1349 #
1350 # For an example of how to use this field, seeUse
1351 # a custom policy.
1352 },
1353 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
1354 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
1355 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
1356 # about these values, see the description of localityLbPolicy.
1357 #
1358 # Do not specify the same policy more than once for a
1359 # backend. If you do, the configuration is rejected.
1360 },
1361 },
1362 ],
1363 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
1364 # possible values are:
1365 #
1366 # - ROUND_ROBIN: This is a simple policy in which each healthy
1367 # backend is selected in round robin order. This is the default.
1368 # - LEAST_REQUEST: An O(1) algorithm which
1369 # selects two random healthy hosts and picks the host which has fewer active
1370 # requests.
1371 # - RING_HASH: The ring/modulo hash load balancer implements
1372 # consistent hashing to backends. The algorithm has the property that the
1373 # addition/removal of a host from a set of N hosts only affects 1/N of the
1374 # requests.
1375 # - RANDOM: The load balancer selects a random healthy
1376 # host.
1377 # - ORIGINAL_DESTINATION: Backend host is selected
1378 # based on the client connection metadata, i.e., connections are opened to
1379 # the same address as the destination address of the incoming connection
1380 # before the connection was redirected to the load balancer.
1381 # - MAGLEV: used as a drop in replacement for the ring hash
1382 # load balancer. Maglev is not as stable as ring hash but has faster table
1383 # lookup build times and host selection times. For more information about
1384 # Maglev, see Maglev:
1385 # A Fast and Reliable Software Network Load Balancer.
1386 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
1387 # Load Balancing using weights computed from Backend reported Custom Metrics.
1388 # If set, the Backend Service responses are expected to contain non-standard
1389 # HTTP response header field Endpoint-Load-Metrics. The reported
1390 # metrics to use for computing the weights are specified via thecustomMetrics field.
1391 #
1392 # This field is applicable to either:
1393 # - A regional backend service with the service protocol set to HTTP,
1394 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
1395 # INTERNAL_MANAGED.
1396 # - A global backend service with the
1397 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
1398 # EXTERNAL_MANAGED.
1399 #
1400 #
1401 # If sessionAffinity is not configured—that is, if session
1402 # affinity remains at the default value of NONE—then the
1403 # default value for localityLbPolicy
1404 # is ROUND_ROBIN. If session affinity is set to a value other
1405 # than NONE,
1406 # then the default value for localityLbPolicy isMAGLEV.
1407 #
1408 # Only ROUND_ROBIN and RING_HASH are supported
1409 # when the backend service is referenced by a URL map that is bound to
1410 # target gRPC proxy that has validateForProxyless field set to true.
1411 #
1412 # localityLbPolicy cannot be specified with haPolicy.
1413 &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
1414 # by this backend service. If logging is enabled, logs will be exported to
1415 # Stackdriver.
1416 # backend service.
1417 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
1418 # traffic served by this backend service. The default value is false.
1419 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
1420 { # Determines which HTTP headers will be logged to Stackdriver.
1421 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
1422 },
1423 ],
1424 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
1425 { # Determines which HTTP headers will be logged to Stackdriver.
1426 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
1427 },
1428 ],
1429 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
1430 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
1431 # of optional fields you want to include in the logs. For example:
1432 # serverInstance, serverGkeDetails.cluster,
1433 # serverGkeDetails.pod.podNamespace
1434 &quot;A String&quot;,
1435 ],
1436 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
1437 # service. Configures whether all, none or a subset of optional fields
1438 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
1439 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
1440 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
1441 # service. The value of the field must be in [0, 1]. This configures the
1442 # sampling rate of requests to the load balancer where 1.0 means all logged
1443 # requests are reported and 0.0 means no logged requests are reported. The
1444 # default value is 1.0.
1445 },
1446 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
1447 # service. Duration is computed from the beginning of the stream until the
1448 # response has been completely processed, including all retries. A stream
1449 # that does not complete in this duration is closed.
1450 #
1451 # If not specified, there will be no timeout limit, i.e. the maximum
1452 # duration is infinite.
1453 #
1454 # This value can be overridden in the PathMatcher configuration of the
1455 # UrlMap that references this backend service.
1456 #
1457 # This field is only allowed when the loadBalancingScheme of
1458 # the backend service is INTERNAL_SELF_MANAGED.
1459 # as a count of seconds and fractions of seconds at nanosecond
1460 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1461 # or &quot;month&quot;. Range is approximately 10,000 years.
1462 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1463 # Durations less than one second are represented with a 0
1464 # `seconds` field and a positive `nanos` field. Must be from 0
1465 # to 999,999,999 inclusive.
1466 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1467 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1468 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1469 },
1470 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
1471 # controller and read by the backend RCTH
1472 &quot;a_key&quot;: &quot;A String&quot;,
1473 },
1474 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1475 # The name must be 1-63 characters long, and comply withRFC1035.
1476 # Specifically, the name must be 1-63 characters long and match the regular
1477 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1478 # character must be a lowercase letter, and all following characters must
1479 # be a dash, lowercase letter, or digit, except the last character, which
1480 # cannot be a dash.
1481 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
1482 #
1483 # This field must be set for Internal Passthrough Network Load Balancers when
1484 # the haPolicy is enabled, and for External Passthrough Network Load
1485 # Balancers when the haPolicy fastIpMove is enabled.
1486 #
1487 # 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.
1488 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
1489 # Load Balancers.
1490 #
1491 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
1492 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
1493 # endpoints in the local zone.
1494 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
1495 # possible values are:
1496 #
1497 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
1498 # is disabled. The load balancer distributes new connections to all
1499 # healthy backend endpoints across all zones.
1500 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
1501 # enabled. The load balancer distributes new connections to all healthy
1502 # backend endpoints in the local zone only. If there are no healthy
1503 # backend endpoints in the local zone, the load balancer distributes
1504 # new connections to all backend endpoints in the local zone.
1505 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
1506 # enabled. The load balancer distributes new connections to all healthy
1507 # backend endpoints in the local zone only. If there aren&#x27;t enough
1508 # healthy backend endpoints in the local zone, the load balancer
1509 # distributes new connections to all healthy backend endpoints across all
1510 # zones.
1511 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
1512 # of healthy backend endpoints in a zone to the count of backend
1513 # endpoints in that same zone is equal to or above this threshold, the
1514 # load balancer distributes new connections to all healthy endpoints in
1515 # the local zone only. When the ratio of the count of healthy backend
1516 # endpoints in a zone to the count of backend endpoints in that same
1517 # zone is below this threshold, the load balancer distributes all new
1518 # connections to all healthy endpoints across all zones.
1519 },
1520 },
1521 &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.
1522 # the backend service.
1523 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
1524 # service.
1525 },
1526 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
1527 # load balancing pool of each individual proxy instance that processes the
1528 # traffic for the given backend service. If not set, this feature is
1529 # considered disabled.
1530 #
1531 # Results of the outlier detection algorithm (ejection of endpoints from the
1532 # load balancing pool and returning them back to the pool) are executed
1533 # independently by each proxy instance of the load balancer. In most cases,
1534 # more than one proxy instance handles the traffic received by a backend
1535 # service. Thus, it is possible that an unhealthy endpoint is detected and
1536 # ejected by only some of the proxies, and while this happens, other proxies
1537 # may continue to send requests to the same unhealthy endpoint until they
1538 # detect and eject the unhealthy endpoint.
1539 #
1540 # Applicable backend endpoints can be:
1541 #
1542 # - VM instances in an Instance Group
1543 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
1544 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
1545 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
1546 # Functions Services
1547 # - Private Service Connect NEGs, that resolve to
1548 # Google-managed regional API endpoints or managed services published using
1549 # Private Service Connect
1550 #
1551 #
1552 #
1553 # Applicable backend service types can be:
1554 #
1555 # - A global backend service with the loadBalancingScheme set to
1556 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
1557 # - A regional backend
1558 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
1559 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
1560 # supported for Serverless NEGs.
1561 #
1562 #
1563 #
1564 # Not supported when the backend service is referenced by a URL map that is
1565 # bound to target gRPC proxy that has validateForProxyless field set to true.
1566 # pool for the backend service.
1567 &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
1568 # or 30s.
1569 #
1570 # After a backend endpoint is returned back to the load balancing pool, it
1571 # can be ejected again in another ejection analysis. Thus, the total ejection
1572 # time is equal to the base ejection time multiplied by the number of times
1573 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
1574 # as a count of seconds and fractions of seconds at nanosecond
1575 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1576 # or &quot;month&quot;. Range is approximately 10,000 years.
1577 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1578 # Durations less than one second are represented with a 0
1579 # `seconds` field and a positive `nanos` field. Must be from 0
1580 # to 999,999,999 inclusive.
1581 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1582 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1583 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1584 },
1585 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
1586 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
1587 # return code qualifies as an error. Defaults to 5.
1588 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
1589 # connection errors that are mapped to one of those status codes) before a
1590 # consecutive gateway failure ejection occurs. Defaults to 3.
1591 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
1592 # outlier status is detected through consecutive 5xx. This setting can be
1593 # used to disable ejection or to ramp it up slowly. Defaults to 0.
1594 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
1595 # outlier status is detected through consecutive gateway failures. This
1596 # setting can be used to disable ejection or to ramp it up slowly. Defaults
1597 # to 100.
1598 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
1599 # outlier status is detected through success rate statistics. This setting
1600 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
1601 #
1602 # Not supported when the backend service uses Serverless NEG.
1603 &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
1604 # ejections and backend endpoints being returned to service. The interval is
1605 # equal to the number of seconds as defined in
1606 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
1607 # in outlierDetection.interval.nanos. Defaults to 1 second.
1608 # as a count of seconds and fractions of seconds at nanosecond
1609 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1610 # or &quot;month&quot;. Range is approximately 10,000 years.
1611 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1612 # Durations less than one second are represented with a 0
1613 # `seconds` field and a positive `nanos` field. Must be from 0
1614 # to 999,999,999 inclusive.
1615 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1616 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1617 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1618 },
1619 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
1620 # backend service that can be ejected if the ejection conditions are met.
1621 # Defaults to 50%.
1622 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
1623 # enough request volume to detect success rate outliers. If the number of
1624 # backend endpoints is fewer than this setting, outlier detection via success
1625 # rate statistics is not performed for any backend endpoint in the load
1626 # balancing pool. Defaults to 5.
1627 #
1628 # Not supported when the backend service uses Serverless NEG.
1629 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
1630 # (as defined by the interval duration above) to include this backend
1631 # endpoint in success rate based outlier detection. If the volume is lower
1632 # than this setting, outlier detection via success rate statistics is not
1633 # performed for that backend endpoint. Defaults to 100.
1634 #
1635 # Not supported when the backend service uses Serverless NEG.
1636 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
1637 # outlier ejection. The ejection threshold is the difference between the mean
1638 # success rate, and the product of this factor and the standard deviation of
1639 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
1640 # is divided by a thousand to get a double. That is, if the desired factor
1641 # is 1.9, the runtime value should be 1900. Defaults to 1900.
1642 #
1643 # Not supported when the backend service uses Serverless NEG.
1644 },
1645 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
1646 # as part of resource payload.
1647 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
1648 # Tag keys and values have the same definition as resource
1649 # manager tags. The field is allowed for INSERT
1650 # only. The keys/values to set on the resource should be specified in
1651 # either ID { : } or Namespaced format
1652 # { : }.
1653 # For example the following are valid inputs:
1654 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
1655 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
1656 # Note:
1657 # * Invalid combinations of ID &amp; namespaced format is not supported. For
1658 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
1659 &quot;a_key&quot;: &quot;A String&quot;,
1660 },
1661 },
1662 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
1663 # the backend. The default value is 80.
1664 # For internal passthrough Network Load Balancers and external passthrough
1665 # Network Load Balancers, omit port.
1666 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
1667 # communication to the backend VMs in that group. The
1668 # named port must be [defined on each backend instance
1669 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
1670 # This parameter has no meaning if the backends are NEGs. For internal
1671 # passthrough Network Load Balancers and external passthrough Network Load
1672 # Balancers, omit port_name.
1673 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
1674 # with backends.
1675 #
1676 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
1677 # depending on the chosen load balancer or Traffic Director configuration.
1678 # Refer to the documentation for the load balancers or for Traffic Director
1679 # for more information.
1680 #
1681 # Must be set to GRPC when the backend service is referenced by a URL map
1682 # that is bound to target gRPC proxy.
1683 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
1684 # resides. This field is not applicable to global backend services.
1685 # You must specify this field as part of the HTTP request URL. It is
1686 # not settable as a field in the request body.
1687 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
1688 # backend service.
1689 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
1690 # service. This field is applicable to a global backend service with the
1691 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
1692 &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
1693 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
1694 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
1695 # private storage buckets that support Signature Version 4 for authentication.
1696 # The service name for generating the authentication header will always default
1697 # to &#x27;s3&#x27;.
1698 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
1699 # creating a backend that uses AWS v4 signature authentication, but will not
1700 # be returned as part of the configuration when queried with a REST API GET
1701 # request.
1702 #
1703 # @InputOnly
1704 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
1705 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
1706 # keep track of different iterations of your access key.
1707 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
1708 # the name of the region your cloud uses to host your origin. For example,
1709 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
1710 },
1711 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
1712 # that describes how clients should authenticate with this service&#x27;s
1713 # backends.
1714 #
1715 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
1716 # to INTERNAL_SELF_MANAGED.
1717 #
1718 # If left blank, communications are not encrypted.
1719 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
1720 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
1721 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
1722 # specified values, the communication continues. Otherwise, it fails. This
1723 # additional check enables the client to verify that the server is authorized
1724 # to run the requested service.
1725 #
1726 # Note that the contents of the server
1727 # certificate&#x27;s subjectAltName field are configured by the
1728 # Public Key Infrastructure which provisions server identities.
1729 #
1730 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
1731 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
1732 # mode).
1733 &quot;A String&quot;,
1734 ],
1735 },
1736 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1737 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
1738 #
1739 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
1740 # If set, lists of backends and health checks must be both empty.
1741 &quot;A String&quot;,
1742 ],
1743 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
1744 #
1745 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
1746 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
1747 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
1748 #
1749 # Only NONE and HEADER_FIELD are supported
1750 # when the backend service is referenced by a URL map that is bound to
1751 # target gRPC proxy that has validateForProxyless field set to true.
1752 #
1753 # For more details, see:
1754 # [Session
1755 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
1756 #
1757 # sessionAffinity cannot be specified with haPolicy.
1758 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
1759 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
1760 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
1761 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
1762 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
1763 # as a count of seconds and fractions of seconds at nanosecond
1764 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1765 # or &quot;month&quot;. Range is approximately 10,000 years.
1766 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1767 # Durations less than one second are represented with a 0
1768 # `seconds` field and a positive `nanos` field. Must be from 0
1769 # to 999,999,999 inclusive.
1770 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1771 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1772 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1773 },
1774 },
1775 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
1776 # Currently this is applicable only for Internal TCP/UDP load balancing,
1777 # Internal HTTP(S) load balancing and Traffic Director.
1778 &quot;policy&quot;: &quot;A String&quot;,
1779 },
1780 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
1781 # type of load balancer. For more information see,
1782 # Backend service settings.
1783 # The default is 30 seconds.
1784 # The full range of timeout values allowed goes from 1
1785 # through 2,147,483,647 seconds.
1786 #
1787 # This value can be overridden in the PathMatcher configuration of the
1788 # UrlMap that references this backend service.
1789 #
1790 # Not supported when the backend service is referenced by a URL map that is
1791 # bound to target gRPC proxy that has validateForProxyless field set to true.
1792 # Instead, use maxStreamDuration.
1793 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
1794 # when the backend protocol is SSL, HTTPS or HTTP2.
1795 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
1796 # networksecurity.googleapis.com namespace. Can be used in authenticating
1797 # TLS connections to the backend, as specified by the authenticationMode
1798 # field. Can only be specified if authenticationMode is not NONE.
1799 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
1800 # balancer sends this string as the SNI hostname in the TLS connection to
1801 # the backend, and requires that this string match a Subject Alternative
1802 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
1803 # NEG backend, if the SNI is specified here, the load balancer uses it
1804 # regardless of whether the Regional Internet NEG is specified with FQDN or
1805 # IP address and port. When both sni and subjectAltNames[] are specified,
1806 # the load balancer matches the backend certificate&#x27;s SAN only to
1807 # subjectAltNames[].
1808 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
1809 # verifies during a TLS handshake with the backend. When the server
1810 # presents its X.509 certificate to the Load Balancer, the Load Balancer
1811 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
1812 # match one of the subjectAltNames in the list. This field is limited to 5
1813 # entries. When both sni and subjectAltNames[] are specified, the load
1814 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
1815 { # A Subject Alternative Name that the load balancer matches against the SAN
1816 # field in the TLS certificate provided by the backend, specified as either
1817 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
1818 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
1819 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
1820 },
1821 ],
1822 },
1823 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
1824 {
1825 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
1826 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
1827 # and ForwardingRule.
1828 },
1829 ],
1830 },
1831 ],
1832 &quot;warning&quot;: { # Informational warning which replaces the list of
1833 # backend services when the list is empty.
1834 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1835 # Engine returns NO_RESULTS_ON_PAGE if there
1836 # are no results in the response.
1837 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1838 # value format. For example:
1839 #
1840 # &quot;data&quot;: [
1841 # {
1842 # &quot;key&quot;: &quot;scope&quot;,
1843 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1844 # }
1845 {
1846 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1847 # returned. For example, for warnings where there are no results in a list
1848 # request for a particular zone, this key might be scope and
1849 # the key value might be the zone name. Other examples might be a key
1850 # indicating a deprecated resource and a suggested replacement, or a
1851 # warning about invalid network settings (for example, if an instance
1852 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1853 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1854 },
1855 ],
1856 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1857 },
1858 },
1859 },
1860 &quot;kind&quot;: &quot;compute#backendServiceAggregatedList&quot;, # Output only. Type of resource.
1861 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
1862 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1863 # the query parameter pageToken in the next list request.
1864 # Subsequent list requests will have their own nextPageToken to
1865 # continue paging through the results.
1866 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
1867 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
1868 &quot;A String&quot;,
1869 ],
1870 &quot;warning&quot;: { # [Output Only] Informational warning message.
1871 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1872 # Engine returns NO_RESULTS_ON_PAGE if there
1873 # are no results in the response.
1874 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1875 # value format. For example:
1876 #
1877 # &quot;data&quot;: [
1878 # {
1879 # &quot;key&quot;: &quot;scope&quot;,
1880 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1881 # }
1882 {
1883 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1884 # returned. For example, for warnings where there are no results in a list
1885 # request for a particular zone, this key might be scope and
1886 # the key value might be the zone name. Other examples might be a key
1887 # indicating a deprecated resource and a suggested replacement, or a
1888 # warning about invalid network settings (for example, if an instance
1889 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1890 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1891 },
1892 ],
1893 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1894 },
1895 }</pre>
1896 </div>
1897
1898 <div class="method">
1899 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
1900 <pre>Retrieves the next page of results.
1901
1902 Args:
1903 previous_request: The request for the previous page. (required)
1904 previous_response: The response from the request for the previous page. (required)
1905
1906 Returns:
1907 A request object that you can call &#x27;execute()&#x27; on to request the next
1908 page. Returns None if there are no more items in the collection.
1909 </pre>
1910 </div>
1911
1912 <div class="method">
1913 <code class="details" id="close">close()</code>
1914 <pre>Close httplib2 connections.</pre>
1915 </div>
1916
1917 <div class="method">
1918 <code class="details" id="delete">delete(project, backendService, requestId=None, x__xgafv=None)</code>
1919 <pre>Deletes the specified BackendService resource.
1920
1921 Args:
1922 project: string, Project ID for this request. (required)
1923 backendService: string, Name of the BackendService resource to delete. (required)
1924 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1925 that if you must retry your request, the server will know to ignore the
1926 request if it has already been completed.
1927
1928 For example, consider a situation where you make an initial request and
1929 the request times out. If you make the request again with the same
1930 request ID, the server can check if original operation with the same
1931 request ID was received, and if so, will ignore the second request. This
1932 prevents clients from accidentally creating duplicate commitments.
1933
1934 The request ID must be
1935 a valid UUID with the exception that zero UUID is not supported
1936 (00000000-0000-0000-0000-000000000000).
1937 x__xgafv: string, V1 error format.
1938 Allowed values
1939 1 - v1 error format
1940 2 - v2 error format
1941
1942 Returns:
1943 An object of the form:
1944
1945 { # Represents an Operation resource.
1946 #
1947 # Google Compute Engine has three Operation resources:
1948 #
1949 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
1950 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
1951 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
1952 #
1953 # You can use an operation resource to manage asynchronous API requests.
1954 # For more information, readHandling
1955 # API responses.
1956 #
1957 # Operations can be global, regional or zonal.
1958 #
1959 # - For global operations, use the `globalOperations`
1960 # resource.
1961 # - For regional operations, use the
1962 # `regionOperations` resource.
1963 # - For zonal operations, use
1964 # the `zoneOperations` resource.
1965 #
1966 #
1967 #
1968 # For more information, read
1969 # Global, Regional, and Zonal Resources.
1970 #
1971 # Note that completed Operation resources have a limited
1972 # retention period.
1973 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1974 # Not present otherwise.
1975 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1976 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1977 # set when the operation is created.
1978 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1979 # text format.
1980 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1981 # this field will be populated.
1982 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1983 # operation.
1984 {
1985 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1986 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1987 # details. There is a set of defined message types to use for providing
1988 # details.The syntax depends on the error code. For example,
1989 # QuotaExceededInfo will have details when the error code is
1990 # QUOTA_EXCEEDED.
1991 {
1992 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1993 #
1994 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1995 # is not enabled:
1996 #
1997 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1998 # &quot;domain&quot;: &quot;googleapis.com&quot;
1999 # &quot;metadata&quot;: {
2000 # &quot;resource&quot;: &quot;projects/123&quot;,
2001 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2002 # }
2003 # }
2004 #
2005 # This response indicates that the pubsub.googleapis.com API is not enabled.
2006 #
2007 # Example of an error that is returned when attempting to create a Spanner
2008 # instance in a region that is out of stock:
2009 #
2010 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2011 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2012 # &quot;metadata&quot;: {
2013 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2014 # }
2015 # }
2016 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2017 # is typically the registered service name of the tool or product that
2018 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2019 # generated by some common infrastructure, the error domain must be a
2020 # globally unique value that identifies the infrastructure. For Google API
2021 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2022 &quot;metadatas&quot;: { # Additional structured details about this error.
2023 #
2024 # Keys must match a regular expression of `a-z+` but should
2025 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2026 # length. When identifying the current value of an exceeded limit, the units
2027 # should be contained in the key, not the value. For example, rather than
2028 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2029 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2030 # instances that can be created in a single (batch) request.
2031 &quot;a_key&quot;: &quot;A String&quot;,
2032 },
2033 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2034 # proximate cause of the error. Error reasons are unique within a particular
2035 # domain of errors. This should be at most 63 characters and match a
2036 # regular expression of `A-Z+[A-Z0-9]`, which represents
2037 # UPPER_SNAKE_CASE.
2038 },
2039 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2040 #
2041 # For example, if a quota check failed with an error indicating the calling
2042 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2043 # directly to the right place in the developer console to flip the bit.
2044 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2045 { # Describes a URL link.
2046 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2047 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2048 },
2049 ],
2050 },
2051 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2052 # which can be attached to an RPC error.
2053 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2054 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2055 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2056 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2057 },
2058 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2059 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2060 &quot;a_key&quot;: &quot;A String&quot;,
2061 },
2062 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2063 # type or metric.
2064 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2065 # or metric.
2066 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2067 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2068 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2069 },
2070 },
2071 ],
2072 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2073 # This property is optional.
2074 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2075 },
2076 ],
2077 },
2078 &quot;getVersionOperationMetadata&quot;: {
2079 &quot;inlineSbomInfo&quot;: {
2080 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2081 # appropriate identifiers.
2082 &quot;a_key&quot;: &quot;A String&quot;,
2083 },
2084 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2085 # identifiers.
2086 &quot;a_key&quot;: &quot;A String&quot;,
2087 },
2088 },
2089 },
2090 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2091 # message that was returned, such as `NOT FOUND`.
2092 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2093 # status code that was returned. For example, a `404` means the
2094 # resource was not found.
2095 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2096 # defined by the server.
2097 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2098 # This value is inRFC3339
2099 # text format.
2100 &quot;instancesBulkInsertOperationMetadata&quot;: {
2101 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2102 # Example key: zones/us-central1-a
2103 &quot;a_key&quot;: {
2104 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2105 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2106 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2107 # error.
2108 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2109 # if the flow is rolling forward or rolling back.
2110 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2111 },
2112 },
2113 },
2114 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2115 # Operation resources.
2116 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2117 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2118 # group of operations results from a `bulkInsert` API request.
2119 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2120 # `update`, or `delete`, and so on.
2121 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2122 # There is no requirement that this be linear or support any granularity of
2123 # operations. This should not be used to guess when the operation will be
2124 # complete. This number should monotonically increase as the operation
2125 # progresses.
2126 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2127 # applicable when performing regional operations.
2128 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2129 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2130 # this field will contain information on all underlying zonal actions and
2131 # their state.
2132 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2133 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2134 # Example key: zones/us-central1-a
2135 &quot;a_key&quot;: {
2136 &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
2137 # populated.
2138 # different programming environments, including REST APIs and RPC APIs. It is
2139 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2140 # three pieces of data: error code, error message, and error details.
2141 #
2142 # You can find out more about this error model and how to work with it in the
2143 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2144 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2145 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2146 # message types for APIs to use.
2147 {
2148 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2149 },
2150 ],
2151 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2152 # user-facing error message should be localized and sent in the
2153 # google.rpc.Status.details field, or localized by the client.
2154 },
2155 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2156 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2157 },
2158 },
2159 },
2160 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2161 # This value is inRFC3339
2162 # text format.
2163 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2164 # following:
2165 # `PENDING`, `RUNNING`, or `DONE`.
2166 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2167 # operation.
2168 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2169 # of the target resource.
2170 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2171 # operations related to creating a snapshot, this points to the disk
2172 # that the snapshot was created from.
2173 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2174 # `[email protected]` or
2175 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2176 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2177 # operation, this field will be populated.
2178 {
2179 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2180 # Engine returns NO_RESULTS_ON_PAGE if there
2181 # are no results in the response.
2182 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2183 # value format. For example:
2184 #
2185 # &quot;data&quot;: [
2186 # {
2187 # &quot;key&quot;: &quot;scope&quot;,
2188 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2189 # }
2190 {
2191 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2192 # returned. For example, for warnings where there are no results in a list
2193 # request for a particular zone, this key might be scope and
2194 # the key value might be the zone name. Other examples might be a key
2195 # indicating a deprecated resource and a suggested replacement, or a
2196 # warning about invalid network settings (for example, if an instance
2197 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2198 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2199 },
2200 ],
2201 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2202 },
2203 ],
2204 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2205 # applicable when performing per-zone operations.
2206 }</pre>
2207 </div>
2208
2209 <div class="method">
2210 <code class="details" id="deleteSignedUrlKey">deleteSignedUrlKey(project, backendService, keyName, requestId=None, x__xgafv=None)</code>
2211 <pre>Deletes a key for validating requests with signed URLs for this backend
2212 service.
2213
2214 Args:
2215 project: string, Project ID for this request. (required)
2216 backendService: string, Name of the BackendService resource to which the Signed URL Key should be
2217 added. The name should conform to RFC1035. (required)
2218 keyName: string, The name of the Signed URL Key to delete. (required)
2219 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2220 that if you must retry your request, the server will know to ignore the
2221 request if it has already been completed.
2222
2223 For example, consider a situation where you make an initial request and
2224 the request times out. If you make the request again with the same
2225 request ID, the server can check if original operation with the same
2226 request ID was received, and if so, will ignore the second request. This
2227 prevents clients from accidentally creating duplicate commitments.
2228
2229 The request ID must be
2230 a valid UUID with the exception that zero UUID is not supported
2231 (00000000-0000-0000-0000-000000000000).
2232 x__xgafv: string, V1 error format.
2233 Allowed values
2234 1 - v1 error format
2235 2 - v2 error format
2236
2237 Returns:
2238 An object of the form:
2239
2240 { # Represents an Operation resource.
2241 #
2242 # Google Compute Engine has three Operation resources:
2243 #
2244 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
2245 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
2246 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
2247 #
2248 # You can use an operation resource to manage asynchronous API requests.
2249 # For more information, readHandling
2250 # API responses.
2251 #
2252 # Operations can be global, regional or zonal.
2253 #
2254 # - For global operations, use the `globalOperations`
2255 # resource.
2256 # - For regional operations, use the
2257 # `regionOperations` resource.
2258 # - For zonal operations, use
2259 # the `zoneOperations` resource.
2260 #
2261 #
2262 #
2263 # For more information, read
2264 # Global, Regional, and Zonal Resources.
2265 #
2266 # Note that completed Operation resources have a limited
2267 # retention period.
2268 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2269 # Not present otherwise.
2270 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2271 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2272 # set when the operation is created.
2273 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2274 # text format.
2275 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2276 # this field will be populated.
2277 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2278 # operation.
2279 {
2280 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2281 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2282 # details. There is a set of defined message types to use for providing
2283 # details.The syntax depends on the error code. For example,
2284 # QuotaExceededInfo will have details when the error code is
2285 # QUOTA_EXCEEDED.
2286 {
2287 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2288 #
2289 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2290 # is not enabled:
2291 #
2292 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2293 # &quot;domain&quot;: &quot;googleapis.com&quot;
2294 # &quot;metadata&quot;: {
2295 # &quot;resource&quot;: &quot;projects/123&quot;,
2296 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2297 # }
2298 # }
2299 #
2300 # This response indicates that the pubsub.googleapis.com API is not enabled.
2301 #
2302 # Example of an error that is returned when attempting to create a Spanner
2303 # instance in a region that is out of stock:
2304 #
2305 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2306 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2307 # &quot;metadata&quot;: {
2308 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2309 # }
2310 # }
2311 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2312 # is typically the registered service name of the tool or product that
2313 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2314 # generated by some common infrastructure, the error domain must be a
2315 # globally unique value that identifies the infrastructure. For Google API
2316 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2317 &quot;metadatas&quot;: { # Additional structured details about this error.
2318 #
2319 # Keys must match a regular expression of `a-z+` but should
2320 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2321 # length. When identifying the current value of an exceeded limit, the units
2322 # should be contained in the key, not the value. For example, rather than
2323 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2324 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2325 # instances that can be created in a single (batch) request.
2326 &quot;a_key&quot;: &quot;A String&quot;,
2327 },
2328 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2329 # proximate cause of the error. Error reasons are unique within a particular
2330 # domain of errors. This should be at most 63 characters and match a
2331 # regular expression of `A-Z+[A-Z0-9]`, which represents
2332 # UPPER_SNAKE_CASE.
2333 },
2334 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2335 #
2336 # For example, if a quota check failed with an error indicating the calling
2337 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2338 # directly to the right place in the developer console to flip the bit.
2339 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2340 { # Describes a URL link.
2341 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2342 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2343 },
2344 ],
2345 },
2346 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2347 # which can be attached to an RPC error.
2348 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2349 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2350 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2351 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2352 },
2353 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2354 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2355 &quot;a_key&quot;: &quot;A String&quot;,
2356 },
2357 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2358 # type or metric.
2359 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2360 # or metric.
2361 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2362 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2363 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2364 },
2365 },
2366 ],
2367 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2368 # This property is optional.
2369 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2370 },
2371 ],
2372 },
2373 &quot;getVersionOperationMetadata&quot;: {
2374 &quot;inlineSbomInfo&quot;: {
2375 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2376 # appropriate identifiers.
2377 &quot;a_key&quot;: &quot;A String&quot;,
2378 },
2379 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2380 # identifiers.
2381 &quot;a_key&quot;: &quot;A String&quot;,
2382 },
2383 },
2384 },
2385 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2386 # message that was returned, such as `NOT FOUND`.
2387 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2388 # status code that was returned. For example, a `404` means the
2389 # resource was not found.
2390 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2391 # defined by the server.
2392 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2393 # This value is inRFC3339
2394 # text format.
2395 &quot;instancesBulkInsertOperationMetadata&quot;: {
2396 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2397 # Example key: zones/us-central1-a
2398 &quot;a_key&quot;: {
2399 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2400 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2401 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2402 # error.
2403 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2404 # if the flow is rolling forward or rolling back.
2405 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2406 },
2407 },
2408 },
2409 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2410 # Operation resources.
2411 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2412 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2413 # group of operations results from a `bulkInsert` API request.
2414 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2415 # `update`, or `delete`, and so on.
2416 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2417 # There is no requirement that this be linear or support any granularity of
2418 # operations. This should not be used to guess when the operation will be
2419 # complete. This number should monotonically increase as the operation
2420 # progresses.
2421 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2422 # applicable when performing regional operations.
2423 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2424 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2425 # this field will contain information on all underlying zonal actions and
2426 # their state.
2427 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2428 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2429 # Example key: zones/us-central1-a
2430 &quot;a_key&quot;: {
2431 &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
2432 # populated.
2433 # different programming environments, including REST APIs and RPC APIs. It is
2434 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2435 # three pieces of data: error code, error message, and error details.
2436 #
2437 # You can find out more about this error model and how to work with it in the
2438 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2439 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2440 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2441 # message types for APIs to use.
2442 {
2443 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2444 },
2445 ],
2446 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2447 # user-facing error message should be localized and sent in the
2448 # google.rpc.Status.details field, or localized by the client.
2449 },
2450 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2451 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2452 },
2453 },
2454 },
2455 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2456 # This value is inRFC3339
2457 # text format.
2458 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2459 # following:
2460 # `PENDING`, `RUNNING`, or `DONE`.
2461 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2462 # operation.
2463 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2464 # of the target resource.
2465 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2466 # operations related to creating a snapshot, this points to the disk
2467 # that the snapshot was created from.
2468 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2469 # `[email protected]` or
2470 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2471 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2472 # operation, this field will be populated.
2473 {
2474 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2475 # Engine returns NO_RESULTS_ON_PAGE if there
2476 # are no results in the response.
2477 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2478 # value format. For example:
2479 #
2480 # &quot;data&quot;: [
2481 # {
2482 # &quot;key&quot;: &quot;scope&quot;,
2483 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2484 # }
2485 {
2486 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2487 # returned. For example, for warnings where there are no results in a list
2488 # request for a particular zone, this key might be scope and
2489 # the key value might be the zone name. Other examples might be a key
2490 # indicating a deprecated resource and a suggested replacement, or a
2491 # warning about invalid network settings (for example, if an instance
2492 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2493 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2494 },
2495 ],
2496 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2497 },
2498 ],
2499 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2500 # applicable when performing per-zone operations.
2501 }</pre>
2502 </div>
2503
2504 <div class="method">
2505 <code class="details" id="get">get(project, backendService, x__xgafv=None)</code>
2506 <pre>Returns the specified BackendService resource.
2507
2508 Args:
2509 project: string, Project ID for this request. (required)
2510 backendService: string, Name of the BackendService resource to return. (required)
2511 x__xgafv: string, V1 error format.
2512 Allowed values
2513 1 - v1 error format
2514 2 - v2 error format
2515
2516 Returns:
2517 An object of the form:
2518
2519 { # Represents a Backend Service resource.
2520 #
2521 # A backend service defines how Google Cloud load balancers distribute traffic.
2522 # The backend service configuration contains a set of values, such as the
2523 # protocol used to connect to backends, various distribution and session
2524 # settings, health checks, and timeouts. These settings provide fine-grained
2525 # control over how your load balancer behaves. Most of the settings have
2526 # default values that allow for easy configuration if you need to get started
2527 # quickly.
2528 #
2529 # Backend services in Google Compute Engine can be either regionally or
2530 # globally scoped.
2531 #
2532 # * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices)
2533 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices)
2534 #
2535 # For more information, seeBackend
2536 # Services.
2537 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
2538 # Load Balancers and Traffic Director and requires
2539 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
2540 #
2541 # If set to 0, the cookie is non-persistent and lasts only until
2542 # the end of the browser session (or equivalent). The maximum allowed value
2543 # is two weeks (1,209,600).
2544 #
2545 # Not supported when the backend service is referenced by a URL map that is
2546 # bound to target gRPC proxy that has validateForProxyless field set to true.
2547 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
2548 { # Message containing information of one individual backend.
2549 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
2550 # handle additional traffic or is fully loaded. For usage guidelines, see
2551 # Connection balancing mode.
2552 #
2553 # Backends must use compatible balancing modes. For more information, see
2554 # Supported balancing modes and target capacity settings and
2555 # Restrictions and guidance for instance groups.
2556 #
2557 # Note: Currently, if you use the API to configure incompatible balancing
2558 # modes, the configuration might be accepted even though it has no impact
2559 # and is ignored. Specifically, Backend.maxUtilization is ignored when
2560 # Backend.balancingMode is RATE. In the future, this incompatible combination
2561 # will be rejected.
2562 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
2563 # mode.
2564 # The default value is 1, which means the group serves up to
2565 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
2566 # completely drained, offering 0% of its available capacity. The valid ranges
2567 # are 0.0 and [0.1,1.0].
2568 # You cannot configure a setting larger than 0 and smaller than0.1.
2569 # You cannot configure a setting of 0 when there is only one
2570 # backend attached to the backend service.
2571 #
2572 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
2573 # internet NEGs, regional serverless NEGs, and PSC NEGs.
2574 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
2575 # BalancingMode.
2576 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
2577 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
2578 # Monitoring, but is not used for load balancing.
2579 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
2580 # balancing mode. The valid range is [0.0, 1.0].
2581 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
2582 # long and match the regular expression
2583 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
2584 # first character must be a lowercase letter, and all following
2585 # characters must be a dash, period, underscore, lowercase letter, or
2586 # digit, except the last character, which cannot be a dash, period, or
2587 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
2588 # field can only be used for a global or regional backend service with the
2589 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
2590 },
2591 ],
2592 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
2593 # create the resource.
2594 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
2595 # failover backend can be configured for a given BackendService.
2596 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
2597 # group or network endpoint
2598 # group (NEG) resource. To determine what types of backends a load
2599 # balancer supports, see the [Backend services
2600 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
2601 #
2602 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
2603 # or NEG. Partial URLs are not supported.
2604 #
2605 # If haPolicy is specified, backends must refer to NEG resources of type
2606 # GCE_VM_IP.
2607 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
2608 # guidelines, seeConnection
2609 # balancing mode and Utilization
2610 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
2611 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
2612 # guidelines, seeConnection
2613 # balancing mode and Utilization
2614 # balancing mode.
2615 #
2616 # Not available if the backend&#x27;s balancingMode isRATE.
2617 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
2618 # For usage guidelines, seeConnection
2619 # balancing mode and Utilization
2620 # balancing mode.
2621 #
2622 # Not available if the backend&#x27;s balancingMode isRATE.
2623 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
2624 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
2625 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
2626 # Not available if backend&#x27;s balancingMode is RATE
2627 # or CONNECTION.
2628 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
2629 # Not available if backend&#x27;s balancingMode is RATE
2630 # or CONNECTION.
2631 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
2632 # usage guidelines, seeRate
2633 # balancing mode and Utilization
2634 # balancing mode.
2635 #
2636 # Not available if the backend&#x27;s balancingMode isCONNECTION.
2637 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
2638 # guidelines, seeRate
2639 # balancing mode and Utilization
2640 # balancing mode.
2641 #
2642 # Not available if the backend&#x27;s balancingMode isCONNECTION.
2643 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
2644 # guidelines, seeRate
2645 # balancing mode and Utilization
2646 # balancing mode.
2647 #
2648 # Not available if the backend&#x27;s balancingMode isCONNECTION.
2649 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
2650 #
2651 # For usage guidelines, seeUtilization
2652 # balancing mode.
2653 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
2654 # the backend.
2655 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
2656 },
2657 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
2658 # sending traffic to backends with default preference. The possible values
2659 # are:
2660 #
2661 # - PREFERRED: Backends with this preference level will be
2662 # filled up to their capacity limits first, based on RTT.
2663 # - DEFAULT: If preferred backends don&#x27;t have enough
2664 # capacity, backends in this layer would be used and traffic would be
2665 # assigned based on the load balancing algorithm you use. This is the
2666 # default
2667 &quot;trafficDuration&quot;: &quot;A String&quot;,
2668 },
2669 ],
2670 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
2671 # specified load balancer types.
2672 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
2673 # Pragma or Authorization headers. Up to 5 headers can be specified.
2674 # The cache is bypassed for all cdnPolicy.cacheMode settings.
2675 { # Bypass the cache when the specified request headers are present,
2676 # e.g. Pragma or Authorization headers. Values are case insensitive.
2677 # The presence of such a header overrides the cache_mode setting.
2678 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
2679 # Values are case-insensitive.
2680 },
2681 ],
2682 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
2683 # CDN.
2684 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
2685 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
2686 &quot;A String&quot;,
2687 ],
2688 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
2689 # The name=value pair will be used in the cache key Cloud CDN generates.
2690 &quot;A String&quot;,
2691 ],
2692 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
2693 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
2694 # query_string_whitelist and query_string_blacklist. If neither is set, the
2695 # entire query string will be included. If false, the query string will be
2696 # excluded from the cache key entirely.
2697 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
2698 # parameters will be included. Either specify query_string_whitelist or
2699 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
2700 # not treated as delimiters.
2701 &quot;A String&quot;,
2702 ],
2703 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
2704 # parameters will be excluded. Either specify query_string_whitelist or
2705 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
2706 # not treated as delimiters.
2707 &quot;A String&quot;,
2708 ],
2709 },
2710 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
2711 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
2712 # headers to cache content. Responses without these headers will not be
2713 # cached at Google&#x27;s edge, and will require a full trip to the origin on
2714 # every request, potentially impacting performance and increasing load on
2715 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
2716 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
2717 # Warning: this may result in Cloud CDN caching private,
2718 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
2719 # including common image formats, media (video and audio), and web assets
2720 # (JavaScript and CSS). Requests and responses that are marked as
2721 # uncacheable, as well as dynamic content (including HTML), will not be
2722 # cached.
2723 #
2724 # If no value is provided for cdnPolicy.cacheMode, it defaults
2725 # to CACHE_ALL_STATIC.
2726 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
2727 # used to clamp the max-age (or Expires) value sent to the client. With
2728 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
2729 # response max-age directive, along with a &quot;public&quot; directive. For
2730 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
2731 # from the origin (if specified), or else sets the response max-age
2732 # directive to the lesser of the client_ttl and default_ttl, and also
2733 # ensures a &quot;public&quot; cache-control directive is present.
2734 # If a client TTL is not specified, a default value (1 hour) will be used.
2735 # The maximum allowed value is 31,622,400s (1 year).
2736 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
2737 # responses that do not have an existing valid TTL (max-age or s-maxage).
2738 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
2739 # The value of defaultTTL cannot be set to a value greater than that of
2740 # maxTTL, but can be equal.
2741 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
2742 # will overwrite the TTL set in all responses. The maximum allowed value is
2743 # 31,622,400s (1 year), noting that infrequently accessed objects may be
2744 # evicted from the cache before the defined TTL.
2745 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
2746 # origin.
2747 # Cache directives that attempt to set a max-age or s-maxage higher than
2748 # this, or an Expires header more than maxTTL seconds in the future will
2749 # be capped at the value of maxTTL, as if it were the value of an
2750 # s-maxage Cache-Control directive.
2751 # Headers sent to the client will not be modified.
2752 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
2753 # The maximum allowed value is 31,622,400s (1 year), noting that
2754 # infrequently accessed objects may be evicted from the cache before
2755 # the defined TTL.
2756 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
2757 # to apply fine-grained caching for common errors or redirects.
2758 # This can reduce the load on your origin and improve end-user
2759 # experience by reducing response latency.
2760 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
2761 # negative caching applies to responses with the specified response code
2762 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
2763 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
2764 # to all responses with the specified response code, and override any
2765 # caching headers.
2766 # By default, Cloud CDN will apply the following default TTLs to these
2767 # status codes:
2768 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
2769 # HTTP 404 (Not Found), 410 (Gone),
2770 # 451 (Unavailable For Legal Reasons): 120s
2771 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
2772 # These defaults can be overridden in negative_caching_policy.
2773 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
2774 # negative_caching must be enabled to configure negative_caching_policy.
2775 # Omitting the policy and leaving negative_caching enabled will use
2776 # Cloud CDN&#x27;s default cache TTLs.
2777 # Note that when specifying an explicit negative_caching_policy, you
2778 # should take care to specify a cache TTL for all response codes
2779 # that you wish to cache. Cloud CDN will not apply any default
2780 # negative caching when a policy exists.
2781 { # Specify CDN TTLs for response error codes.
2782 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
2783 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
2784 # specified as values, and you cannot specify a status code more than
2785 # once.
2786 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
2787 # corresponding status code.
2788 # The maximum allowed value is 1800s (30 minutes), noting that
2789 # infrequently accessed objects may be evicted from the cache before the
2790 # defined TTL.
2791 },
2792 ],
2793 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
2794 # requests into a small number of requests to the origin.
2795 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
2796 # content with the origin, or when an error is encountered when refreshing
2797 # the cache.
2798 # This setting defines the default &quot;max-stale&quot; duration for any cached
2799 # responses that do not specify a max-stale directive. Stale responses that
2800 # exceed the TTL configured here will not be served. The default limit
2801 # (max-stale) is 86400s (1 day), which will allow stale content to be
2802 # served up to this limit beyond the max-age (or s-maxage) of a cached
2803 # response.
2804 # The maximum allowed value is 604800 (1 week).
2805 # Set this to zero (0) to disable serve-while-stale.
2806 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
2807 # considered fresh. After this time period, the response will be
2808 # revalidated before being served. Defaults to 1hr (3600s). When serving
2809 # responses to signed URL requests, Cloud CDN will internally behave as
2810 # though all responses from this backend had a &quot;Cache-Control:
2811 # public, max-age=[TTL]&quot; header, regardless of any existing
2812 # Cache-Control header. The actual headers served in responses will not be
2813 # altered.
2814 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
2815 &quot;A String&quot;,
2816 ],
2817 },
2818 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
2819 # backend service.
2820 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
2821 # there is no limit.
2822 #
2823 # Not supported when the backend service is referenced by a URL map that is
2824 # bound to target gRPC proxy that has validateForProxyless field set to true.
2825 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
2826 # not specified, there is no limit.
2827 #
2828 # Not supported when the backend service is referenced by a URL map that is
2829 # bound to target gRPC proxy that has validateForProxyless field set to true.
2830 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
2831 # service. If not specified, there is no limit.
2832 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
2833 # This parameter is respected by both the HTTP/1.1 and HTTP/2
2834 # implementations. If not specified, there is no limit. Setting this
2835 # parameter to 1 will effectively disable keep alive.
2836 #
2837 # Not supported when the backend service is referenced by a URL map that is
2838 # bound to target gRPC proxy that has validateForProxyless field set to true.
2839 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
2840 # not specified, the default is 1.
2841 #
2842 # Not supported when the backend service is referenced by a URL map that is
2843 # bound to target gRPC proxy that has validateForProxyless field set to true.
2844 },
2845 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
2846 # the client&#x27;s Accept-Encoding header.
2847 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
2848 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
2849 # instance. For supported load balancers and protocols, as described inEnabling
2850 # connection draining.
2851 },
2852 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
2853 # tracking policy settings are only available for external passthrough
2854 # Network Load Balancers and internal passthrough Network Load Balancers.
2855 #
2856 # connectionTrackingPolicy cannot be specified with haPolicy.
2857 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
2858 # value is DEFAULT_FOR_PROTOCOL.
2859 #
2860 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
2861 # persist on unhealthy backends only for connection-oriented protocols
2862 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
2863 # Affinity is configured for 5-tuple. They do not persist forUDP.
2864 #
2865 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
2866 # the existing connections on the unhealthy backend are never persisted on
2867 # the unhealthy backend. They are always diverted to newly selected healthy
2868 # backends (unless all backends are unhealthy).
2869 #
2870 # If set to ALWAYS_PERSIST, existing connections always
2871 # persist on unhealthy backends regardless of protocol and session
2872 # affinity. It is generally not recommended to use this mode overriding the
2873 # default.
2874 #
2875 # For more details, see [Connection Persistence for Network Load
2876 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
2877 # and [Connection Persistence for Internal TCP/UDP Load
2878 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
2879 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
2880 # Balancers. This option is not available publicly.
2881 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
2882 # matching traffic (in seconds).
2883 #
2884 # For internal passthrough Network Load Balancers:
2885 #
2886 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
2887 # - It can be set only if Connection Tracking is less than 5-tuple
2888 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
2889 # Mode is PER_SESSION).
2890 #
2891 #
2892 #
2893 # For external passthrough Network Load Balancers the default is 60
2894 # seconds. This option is not available publicly.
2895 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
2896 # options:
2897 #
2898 # - PER_CONNECTION: This is the default mode. The Connection
2899 # Tracking is performed as per the Connection Key (default Hash Method) for
2900 # the specific protocol.
2901 # - PER_SESSION: The Connection Tracking is performed as per
2902 # the configured Session Affinity. It matches the configured Session
2903 # Affinity.
2904 #
2905 #
2906 #
2907 # For more details, see [Tracking Mode for Network Load
2908 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
2909 # and [Tracking Mode for Internal TCP/UDP Load
2910 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
2911 },
2912 &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
2913 # affinity based on HTTP headers, cookies or other properties. This load
2914 # balancing policy is applicable only for HTTP connections. The affinity to a
2915 # particular destination host will be lost when one or more hosts are
2916 # added/removed from the destination service. This field specifies parameters
2917 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
2918 #
2919 # This field is applicable to either:
2920 #
2921 # - A regional backend service with the service protocol set to HTTP,
2922 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
2923 # INTERNAL_MANAGED.
2924 # - A global backend service with the
2925 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
2926 &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
2927 # be used as the hash key for the consistent hash load balancer. If the
2928 # cookie is not present, it will be generated. This field is applicable if
2929 # the sessionAffinity is set to HTTP_COOKIE.
2930 #
2931 # Not supported when the backend service is referenced by a URL map that is
2932 # bound to target gRPC proxy that has validateForProxyless field set to true.
2933 # for load balancing policies that use a consistent hash.
2934 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
2935 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
2936 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
2937 # as a count of seconds and fractions of seconds at nanosecond
2938 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2939 # or &quot;month&quot;. Range is approximately 10,000 years.
2940 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2941 # Durations less than one second are represented with a 0
2942 # `seconds` field and a positive `nanos` field. Must be from 0
2943 # to 999,999,999 inclusive.
2944 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2945 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2946 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2947 },
2948 },
2949 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
2950 # applicable if the sessionAffinity is set toHEADER_FIELD.
2951 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
2952 # 1024. Larger ring sizes result in more granular load distributions. If the
2953 # number of hosts in the load balancing pool is larger than the ring size,
2954 # each host will be assigned a single virtual node.
2955 },
2956 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2957 # text format.
2958 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
2959 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
2960 # locality_lb_policy.
2961 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
2962 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
2963 # long and match the regular expression
2964 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
2965 # first character must be a lowercase letter, and all following
2966 # characters must be a dash, period, underscore, lowercase letter, or
2967 # digit, except the last character, which cannot be a dash, period, or
2968 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
2969 # field can only be used for a global or regional backend service with the
2970 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
2971 },
2972 ],
2973 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
2974 # custom
2975 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
2976 &quot;A String&quot;,
2977 ],
2978 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
2979 # custom
2980 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
2981 &quot;A String&quot;,
2982 ],
2983 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
2984 # create the resource.
2985 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
2986 # this backend service.
2987 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
2988 # global external Application Load Balancer.
2989 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
2990 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
2991 #
2992 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
2993 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
2994 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
2995 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
2996 # externalManagedMigrationTestingPercentage.
2997 #
2998 # Rolling back a migration requires the states to be set in reverse order. So
2999 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
3000 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
3001 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
3002 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
3003 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
3004 # external Application Load Balancer.
3005 #
3006 # The value of this field must be in the range [0, 100].
3007 #
3008 # Session affinity options will slightly affect this routing behavior, for
3009 # more details, see:Session
3010 # Affinity.
3011 #
3012 # This value can only be set if the loadBalancingScheme in the BackendService
3013 # is set to EXTERNAL (when using the classic Application Load Balancer) and
3014 # the migration state is TEST_BY_PERCENTAGE.
3015 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
3016 # as a backup (failover) backend.
3017 # For load balancers that have configurable failover:
3018 # [Internal passthrough Network Load
3019 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
3020 # and [external passthrough Network Load
3021 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
3022 #
3023 # failoverPolicy cannot be specified with haPolicy.
3024 # failover:
3025 # [Internal passthrough Network Load
3026 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
3027 # and [external passthrough
3028 # Network Load
3029 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
3030 # On failover or failback, this field indicates whether connection draining
3031 # will be honored. Google Cloud has a fixed connection draining timeout of
3032 # 10 minutes. A setting of true terminates existing TCP
3033 # connections to the active pool during failover and failback, immediately
3034 # draining traffic. A setting of false allows existing TCP
3035 # connections to persist, even on VMs no longer in the active pool, for up
3036 # to the duration of the connection draining timeout (10 minutes).
3037 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
3038 #
3039 # The default is false.
3040 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
3041 # load balancer are dropped when all primary and all backup backend VMs are
3042 # unhealthy.If set to false, connections are distributed
3043 # among all primary VMs when all primary and all backup backend VMs are
3044 # unhealthy.
3045 # For load balancers that have configurable
3046 # failover:
3047 # [Internal passthrough
3048 # Network Load
3049 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
3050 # and [external passthrough
3051 # Network Load
3052 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
3053 # The default is false.
3054 &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
3055 # failover when the number of healthy primary VMs equals zero.
3056 # For all other values, the load balancer performs a failover when the
3057 # total number of healthy primary VMs is less than this ratio.
3058 # For load balancers that have configurable
3059 # failover:
3060 # [Internal TCP/UDP Load
3061 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
3062 # and [external TCP/UDP Load
3063 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
3064 },
3065 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
3066 # This field is used in optimistic locking. This field will be ignored when
3067 # inserting a BackendService. An up-to-date fingerprint must be provided in
3068 # order to update the BackendService, otherwise the request will
3069 # fail with error 412 conditionNotMet.
3070 #
3071 # To see the latest fingerprint, make a get() request to
3072 # retrieve a BackendService.
3073 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
3074 # Protocol Forwarding.
3075 #
3076 # The backends of this regional backend service must only specify zonal
3077 # network endpoint groups (NEGs) of type GCE_VM_IP.
3078 #
3079 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
3080 # regional backend service must set the network field. All zonal NEGs must
3081 # belong to the same network. However, individual NEGs can
3082 # belong to different subnetworks of that network.
3083 #
3084 # When haPolicy is specified, the set of attached network endpoints across
3085 # all backends comprise an High Availability domain from which one endpoint
3086 # is selected as the active endpoint (the leader) that receives all
3087 # traffic.
3088 #
3089 # haPolicy can be added only at backend service creation time. Once set up,
3090 # it cannot be deleted.
3091 #
3092 # Note that haPolicy is not for load balancing, and therefore cannot be
3093 # specified with sessionAffinity, connectionTrackingPolicy, and
3094 # failoverPolicy.
3095 #
3096 # haPolicy requires customers to be responsible for tracking backend
3097 # endpoint health and electing a leader among the healthy endpoints.
3098 # Therefore, haPolicy cannot be specified with healthChecks.
3099 #
3100 # haPolicy can only be specified for External Passthrough Network Load
3101 # Balancers and Internal Passthrough Network Load Balancers.
3102 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
3103 # achieve it.
3104 #
3105 # Supported values are:
3106 #
3107 # - DISABLED: Fast IP Move is disabled. You can only use the
3108 # haPolicy.leader API to update the leader.
3109 # - &gt;GARP_RA: Provides a method to very quickly define a new network
3110 # endpoint as the leader. This method is faster than updating the leader
3111 # using the haPolicy.leader API. Fast IP move works as follows: The VM
3112 # hosting the network endpoint that should become the new leader sends
3113 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
3114 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
3115 # temporarily associates the forwarding rule IP address with that VM, and
3116 # both new and in-flight packets are quickly delivered to that VM.
3117 #
3118 #
3119 #
3120 # Note the important properties of the Fast IP Move functionality:
3121 #
3122 # - The GARP/RA-initiated re-routing stays active for approximately 20
3123 # minutes. After triggering fast failover, you must also
3124 # appropriately set the haPolicy.leader.
3125 # - The new leader instance should continue to send GARP/RA packets
3126 # periodically every 10 seconds until at least 10 minutes after updating
3127 # the haPolicy.leader (but stop immediately if it is no longer the leader).
3128 # - After triggering a fast failover, we recommend that you wait at least
3129 # 3 seconds before sending another GARP/RA packet from a different VM
3130 # instance to avoid race conditions.
3131 # - Don&#x27;t send GARP/RA packets from different VM
3132 # instances at the same time. If multiple instances continue to send
3133 # GARP/RA packets, traffic might be routed to different destinations in an
3134 # alternating order. This condition ceases when a single instance
3135 # issues a GARP/RA packet.
3136 # - The GARP/RA request always takes priority over the leader API.
3137 # Using the haPolicy.leader API to change the leader to a different
3138 # instance will have no effect until the GARP/RA request becomes
3139 # inactive.
3140 # - The GARP/RA packets should follow the GARP/RA
3141 # Packet Specifications..
3142 # - When multiple forwarding rules refer to a regional backend service,
3143 # you need only send a GARP or RA packet for a single forwarding rule
3144 # virtual IP. The virtual IPs for all forwarding rules targeting the same
3145 # backend service will also be moved to the sender of the GARP or RA
3146 # packet.
3147 #
3148 #
3149 #
3150 # The following are the Fast IP Move limitations (that is, when fastIPMove
3151 # is not DISABLED):
3152 #
3153 # - Multiple forwarding rules cannot use the same IP address if one of
3154 # them refers to a regional backend service with fastIPMove.
3155 # - The regional backend service must set the network field, and all
3156 # NEGs must belong to that network. However, individual
3157 # NEGs can belong to different subnetworks of that network.
3158 # - The maximum number of network endpoints across all backends of a
3159 # backend service with fastIPMove is 32.
3160 # - The maximum number of backend services with fastIPMove that can have
3161 # the same network endpoint attached to one of its backends is 64.
3162 # - The maximum number of backend services with fastIPMove in a VPC in a
3163 # region is 64.
3164 # - The network endpoints that are attached to a backend of a backend
3165 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
3166 # - Traffic directed to the leader by a static route next hop will not be
3167 # redirected to a new leader by fast failover. Such traffic will only be
3168 # redirected once an haPolicy.leader update has taken effect. Only traffic
3169 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
3170 # fast failover.
3171 #
3172 #
3173 # haPolicy.fastIPMove can be set only at backend service creation time.
3174 # Once set, it cannot be updated.
3175 #
3176 # By default, fastIpMove is set to DISABLED.
3177 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
3178 # this service as the active endpoint (the leader) that receives all
3179 # traffic.
3180 #
3181 # When the leader changes, there is no connection draining to persist
3182 # existing connections on the old leader.
3183 #
3184 # You are responsible for selecting a suitable endpoint as the
3185 # leader. For example, preferring a healthy endpoint over unhealthy ones.
3186 # Note that this service does not track backend endpoint health, and
3187 # selects the configured leader unconditionally.
3188 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
3189 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
3190 # that the leader is attached to.
3191 #
3192 # The leader&#x27;s backendGroup must already be specified as a backend of
3193 # this backend service. Removing a backend that is designated as the
3194 # leader&#x27;s backendGroup is not permitted.
3195 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
3196 # designated as the leader.
3197 #
3198 # This network endpoint cannot be detached from the NEG specified in
3199 # the haPolicy.leader.backendGroup until the leader is updated with
3200 # another network endpoint, or the leader is removed from the haPolicy.
3201 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
3202 # instance must already be attached to the NEG specified in the
3203 # haPolicy.leader.backendGroup.
3204 #
3205 # The name must be 1-63 characters long, and comply with RFC1035.
3206 # Authorization requires the following IAM permission on the
3207 # specified resource instance: compute.instances.use
3208 },
3209 },
3210 },
3211 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
3212 # httpsHealthChecks (legacy) resource for health checking this backend
3213 # service. Not all backend services support legacy health checks. See
3214 # Load balancer guide. Currently, at most one health check can be
3215 # specified for each backend service. Backend services with
3216 # instance group or zonal NEG backends must have a health check unless
3217 # haPolicy is specified. Backend services with internet or serverless NEG
3218 # backends must not have a health check.
3219 #
3220 # healthChecks[] cannot be specified with haPolicy.
3221 &quot;A String&quot;,
3222 ],
3223 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
3224 # Not available for internal passthrough Network Load Balancers and external
3225 # passthrough Network Load Balancers.
3226 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
3227 # incoming requests.
3228 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
3229 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
3230 # For security reasons, this value cannot be retrieved via the API.
3231 # Instead, the SHA-256 hash of the value is returned in the
3232 # oauth2ClientSecretSha256 field.
3233 #
3234 # @InputOnly
3235 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
3236 },
3237 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
3238 # defined by the server.
3239 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
3240 # from the client to the backend for proxyless gRPC).
3241 # The possible values are:
3242 #
3243 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
3244 # backend service (Instance Group, Managed Instance Group, Network Endpoint
3245 # Group), regardless of traffic from the client to the proxy. Only IPv4
3246 # health checks are used to check the health of the backends. This is the
3247 # default setting.
3248 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
3249 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
3250 # address).
3251 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
3252 # backend service (Instance Group, Managed Instance Group, Network Endpoint
3253 # Group), regardless of traffic from the client to the proxy. Only IPv6
3254 # health checks are used to check the health of the backends.
3255 #
3256 #
3257 #
3258 # This field is applicable to either:
3259 #
3260 # - Advanced global external Application Load Balancer (load balancing
3261 # scheme EXTERNAL_MANAGED),
3262 # - Regional external Application Load
3263 # Balancer,
3264 # - Internal proxy Network Load Balancer (load balancing
3265 # scheme INTERNAL_MANAGED),
3266 # - Regional internal Application Load
3267 # Balancer (load balancing scheme INTERNAL_MANAGED),
3268 # - Traffic
3269 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
3270 # INTERNAL_SELF_MANAGED).
3271 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
3272 # for backend services.
3273 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
3274 # created for one type of load balancer cannot be used with another.
3275 # For more information, refer toChoosing
3276 # a load balancer.
3277 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
3278 # preference. When you use localityLbPolicies, you must set at least one
3279 # value for either the localityLbPolicies[].policy or the
3280 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
3281 # value set in the localityLbPolicy field.
3282 #
3283 # For an example of how to use this field, seeDefine
3284 # a list of preferred policies.
3285 #
3286 # Caution: This field and its children are intended for use in a service mesh
3287 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
3288 # that have this configuration.
3289 { # Container for either a built-in LB policy supported by gRPC or Envoy or
3290 # a custom one implemented by the end user.
3291 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
3292 # deployed with the client.
3293 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
3294 # by a locally installed custom policy implementation.
3295 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
3296 #
3297 # The value should match the name of a custom implementation registered
3298 # on the gRPC clients. It should follow protocol buffer message naming
3299 # conventions and include the full path (for example,
3300 # myorg.CustomLbPolicy). The maximum length is 256 characters.
3301 #
3302 # Do not specify the same custom policy more than once for a
3303 # backend. If you do, the configuration is rejected.
3304 #
3305 # For an example of how to use this field, seeUse
3306 # a custom policy.
3307 },
3308 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
3309 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
3310 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
3311 # about these values, see the description of localityLbPolicy.
3312 #
3313 # Do not specify the same policy more than once for a
3314 # backend. If you do, the configuration is rejected.
3315 },
3316 },
3317 ],
3318 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
3319 # possible values are:
3320 #
3321 # - ROUND_ROBIN: This is a simple policy in which each healthy
3322 # backend is selected in round robin order. This is the default.
3323 # - LEAST_REQUEST: An O(1) algorithm which
3324 # selects two random healthy hosts and picks the host which has fewer active
3325 # requests.
3326 # - RING_HASH: The ring/modulo hash load balancer implements
3327 # consistent hashing to backends. The algorithm has the property that the
3328 # addition/removal of a host from a set of N hosts only affects 1/N of the
3329 # requests.
3330 # - RANDOM: The load balancer selects a random healthy
3331 # host.
3332 # - ORIGINAL_DESTINATION: Backend host is selected
3333 # based on the client connection metadata, i.e., connections are opened to
3334 # the same address as the destination address of the incoming connection
3335 # before the connection was redirected to the load balancer.
3336 # - MAGLEV: used as a drop in replacement for the ring hash
3337 # load balancer. Maglev is not as stable as ring hash but has faster table
3338 # lookup build times and host selection times. For more information about
3339 # Maglev, see Maglev:
3340 # A Fast and Reliable Software Network Load Balancer.
3341 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
3342 # Load Balancing using weights computed from Backend reported Custom Metrics.
3343 # If set, the Backend Service responses are expected to contain non-standard
3344 # HTTP response header field Endpoint-Load-Metrics. The reported
3345 # metrics to use for computing the weights are specified via thecustomMetrics field.
3346 #
3347 # This field is applicable to either:
3348 # - A regional backend service with the service protocol set to HTTP,
3349 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
3350 # INTERNAL_MANAGED.
3351 # - A global backend service with the
3352 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
3353 # EXTERNAL_MANAGED.
3354 #
3355 #
3356 # If sessionAffinity is not configured—that is, if session
3357 # affinity remains at the default value of NONE—then the
3358 # default value for localityLbPolicy
3359 # is ROUND_ROBIN. If session affinity is set to a value other
3360 # than NONE,
3361 # then the default value for localityLbPolicy isMAGLEV.
3362 #
3363 # Only ROUND_ROBIN and RING_HASH are supported
3364 # when the backend service is referenced by a URL map that is bound to
3365 # target gRPC proxy that has validateForProxyless field set to true.
3366 #
3367 # localityLbPolicy cannot be specified with haPolicy.
3368 &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
3369 # by this backend service. If logging is enabled, logs will be exported to
3370 # Stackdriver.
3371 # backend service.
3372 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
3373 # traffic served by this backend service. The default value is false.
3374 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
3375 { # Determines which HTTP headers will be logged to Stackdriver.
3376 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
3377 },
3378 ],
3379 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
3380 { # Determines which HTTP headers will be logged to Stackdriver.
3381 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
3382 },
3383 ],
3384 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
3385 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
3386 # of optional fields you want to include in the logs. For example:
3387 # serverInstance, serverGkeDetails.cluster,
3388 # serverGkeDetails.pod.podNamespace
3389 &quot;A String&quot;,
3390 ],
3391 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
3392 # service. Configures whether all, none or a subset of optional fields
3393 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
3394 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
3395 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
3396 # service. The value of the field must be in [0, 1]. This configures the
3397 # sampling rate of requests to the load balancer where 1.0 means all logged
3398 # requests are reported and 0.0 means no logged requests are reported. The
3399 # default value is 1.0.
3400 },
3401 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
3402 # service. Duration is computed from the beginning of the stream until the
3403 # response has been completely processed, including all retries. A stream
3404 # that does not complete in this duration is closed.
3405 #
3406 # If not specified, there will be no timeout limit, i.e. the maximum
3407 # duration is infinite.
3408 #
3409 # This value can be overridden in the PathMatcher configuration of the
3410 # UrlMap that references this backend service.
3411 #
3412 # This field is only allowed when the loadBalancingScheme of
3413 # the backend service is INTERNAL_SELF_MANAGED.
3414 # as a count of seconds and fractions of seconds at nanosecond
3415 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
3416 # or &quot;month&quot;. Range is approximately 10,000 years.
3417 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
3418 # Durations less than one second are represented with a 0
3419 # `seconds` field and a positive `nanos` field. Must be from 0
3420 # to 999,999,999 inclusive.
3421 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
3422 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
3423 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
3424 },
3425 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
3426 # controller and read by the backend RCTH
3427 &quot;a_key&quot;: &quot;A String&quot;,
3428 },
3429 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
3430 # The name must be 1-63 characters long, and comply withRFC1035.
3431 # Specifically, the name must be 1-63 characters long and match the regular
3432 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
3433 # character must be a lowercase letter, and all following characters must
3434 # be a dash, lowercase letter, or digit, except the last character, which
3435 # cannot be a dash.
3436 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
3437 #
3438 # This field must be set for Internal Passthrough Network Load Balancers when
3439 # the haPolicy is enabled, and for External Passthrough Network Load
3440 # Balancers when the haPolicy fastIpMove is enabled.
3441 #
3442 # 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.
3443 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
3444 # Load Balancers.
3445 #
3446 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
3447 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
3448 # endpoints in the local zone.
3449 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
3450 # possible values are:
3451 #
3452 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
3453 # is disabled. The load balancer distributes new connections to all
3454 # healthy backend endpoints across all zones.
3455 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
3456 # enabled. The load balancer distributes new connections to all healthy
3457 # backend endpoints in the local zone only. If there are no healthy
3458 # backend endpoints in the local zone, the load balancer distributes
3459 # new connections to all backend endpoints in the local zone.
3460 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
3461 # enabled. The load balancer distributes new connections to all healthy
3462 # backend endpoints in the local zone only. If there aren&#x27;t enough
3463 # healthy backend endpoints in the local zone, the load balancer
3464 # distributes new connections to all healthy backend endpoints across all
3465 # zones.
3466 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
3467 # of healthy backend endpoints in a zone to the count of backend
3468 # endpoints in that same zone is equal to or above this threshold, the
3469 # load balancer distributes new connections to all healthy endpoints in
3470 # the local zone only. When the ratio of the count of healthy backend
3471 # endpoints in a zone to the count of backend endpoints in that same
3472 # zone is below this threshold, the load balancer distributes all new
3473 # connections to all healthy endpoints across all zones.
3474 },
3475 },
3476 &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.
3477 # the backend service.
3478 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
3479 # service.
3480 },
3481 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
3482 # load balancing pool of each individual proxy instance that processes the
3483 # traffic for the given backend service. If not set, this feature is
3484 # considered disabled.
3485 #
3486 # Results of the outlier detection algorithm (ejection of endpoints from the
3487 # load balancing pool and returning them back to the pool) are executed
3488 # independently by each proxy instance of the load balancer. In most cases,
3489 # more than one proxy instance handles the traffic received by a backend
3490 # service. Thus, it is possible that an unhealthy endpoint is detected and
3491 # ejected by only some of the proxies, and while this happens, other proxies
3492 # may continue to send requests to the same unhealthy endpoint until they
3493 # detect and eject the unhealthy endpoint.
3494 #
3495 # Applicable backend endpoints can be:
3496 #
3497 # - VM instances in an Instance Group
3498 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
3499 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
3500 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
3501 # Functions Services
3502 # - Private Service Connect NEGs, that resolve to
3503 # Google-managed regional API endpoints or managed services published using
3504 # Private Service Connect
3505 #
3506 #
3507 #
3508 # Applicable backend service types can be:
3509 #
3510 # - A global backend service with the loadBalancingScheme set to
3511 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
3512 # - A regional backend
3513 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
3514 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
3515 # supported for Serverless NEGs.
3516 #
3517 #
3518 #
3519 # Not supported when the backend service is referenced by a URL map that is
3520 # bound to target gRPC proxy that has validateForProxyless field set to true.
3521 # pool for the backend service.
3522 &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
3523 # or 30s.
3524 #
3525 # After a backend endpoint is returned back to the load balancing pool, it
3526 # can be ejected again in another ejection analysis. Thus, the total ejection
3527 # time is equal to the base ejection time multiplied by the number of times
3528 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
3529 # as a count of seconds and fractions of seconds at nanosecond
3530 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
3531 # or &quot;month&quot;. Range is approximately 10,000 years.
3532 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
3533 # Durations less than one second are represented with a 0
3534 # `seconds` field and a positive `nanos` field. Must be from 0
3535 # to 999,999,999 inclusive.
3536 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
3537 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
3538 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
3539 },
3540 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
3541 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
3542 # return code qualifies as an error. Defaults to 5.
3543 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
3544 # connection errors that are mapped to one of those status codes) before a
3545 # consecutive gateway failure ejection occurs. Defaults to 3.
3546 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
3547 # outlier status is detected through consecutive 5xx. This setting can be
3548 # used to disable ejection or to ramp it up slowly. Defaults to 0.
3549 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
3550 # outlier status is detected through consecutive gateway failures. This
3551 # setting can be used to disable ejection or to ramp it up slowly. Defaults
3552 # to 100.
3553 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
3554 # outlier status is detected through success rate statistics. This setting
3555 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
3556 #
3557 # Not supported when the backend service uses Serverless NEG.
3558 &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
3559 # ejections and backend endpoints being returned to service. The interval is
3560 # equal to the number of seconds as defined in
3561 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
3562 # in outlierDetection.interval.nanos. Defaults to 1 second.
3563 # as a count of seconds and fractions of seconds at nanosecond
3564 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
3565 # or &quot;month&quot;. Range is approximately 10,000 years.
3566 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
3567 # Durations less than one second are represented with a 0
3568 # `seconds` field and a positive `nanos` field. Must be from 0
3569 # to 999,999,999 inclusive.
3570 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
3571 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
3572 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
3573 },
3574 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
3575 # backend service that can be ejected if the ejection conditions are met.
3576 # Defaults to 50%.
3577 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
3578 # enough request volume to detect success rate outliers. If the number of
3579 # backend endpoints is fewer than this setting, outlier detection via success
3580 # rate statistics is not performed for any backend endpoint in the load
3581 # balancing pool. Defaults to 5.
3582 #
3583 # Not supported when the backend service uses Serverless NEG.
3584 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
3585 # (as defined by the interval duration above) to include this backend
3586 # endpoint in success rate based outlier detection. If the volume is lower
3587 # than this setting, outlier detection via success rate statistics is not
3588 # performed for that backend endpoint. Defaults to 100.
3589 #
3590 # Not supported when the backend service uses Serverless NEG.
3591 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
3592 # outlier ejection. The ejection threshold is the difference between the mean
3593 # success rate, and the product of this factor and the standard deviation of
3594 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
3595 # is divided by a thousand to get a double. That is, if the desired factor
3596 # is 1.9, the runtime value should be 1900. Defaults to 1900.
3597 #
3598 # Not supported when the backend service uses Serverless NEG.
3599 },
3600 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
3601 # as part of resource payload.
3602 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
3603 # Tag keys and values have the same definition as resource
3604 # manager tags. The field is allowed for INSERT
3605 # only. The keys/values to set on the resource should be specified in
3606 # either ID { : } or Namespaced format
3607 # { : }.
3608 # For example the following are valid inputs:
3609 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
3610 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
3611 # Note:
3612 # * Invalid combinations of ID &amp; namespaced format is not supported. For
3613 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
3614 &quot;a_key&quot;: &quot;A String&quot;,
3615 },
3616 },
3617 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
3618 # the backend. The default value is 80.
3619 # For internal passthrough Network Load Balancers and external passthrough
3620 # Network Load Balancers, omit port.
3621 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
3622 # communication to the backend VMs in that group. The
3623 # named port must be [defined on each backend instance
3624 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
3625 # This parameter has no meaning if the backends are NEGs. For internal
3626 # passthrough Network Load Balancers and external passthrough Network Load
3627 # Balancers, omit port_name.
3628 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
3629 # with backends.
3630 #
3631 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
3632 # depending on the chosen load balancer or Traffic Director configuration.
3633 # Refer to the documentation for the load balancers or for Traffic Director
3634 # for more information.
3635 #
3636 # Must be set to GRPC when the backend service is referenced by a URL map
3637 # that is bound to target gRPC proxy.
3638 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
3639 # resides. This field is not applicable to global backend services.
3640 # You must specify this field as part of the HTTP request URL. It is
3641 # not settable as a field in the request body.
3642 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
3643 # backend service.
3644 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
3645 # service. This field is applicable to a global backend service with the
3646 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
3647 &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
3648 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
3649 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
3650 # private storage buckets that support Signature Version 4 for authentication.
3651 # The service name for generating the authentication header will always default
3652 # to &#x27;s3&#x27;.
3653 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
3654 # creating a backend that uses AWS v4 signature authentication, but will not
3655 # be returned as part of the configuration when queried with a REST API GET
3656 # request.
3657 #
3658 # @InputOnly
3659 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
3660 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
3661 # keep track of different iterations of your access key.
3662 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
3663 # the name of the region your cloud uses to host your origin. For example,
3664 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
3665 },
3666 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
3667 # that describes how clients should authenticate with this service&#x27;s
3668 # backends.
3669 #
3670 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
3671 # to INTERNAL_SELF_MANAGED.
3672 #
3673 # If left blank, communications are not encrypted.
3674 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
3675 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
3676 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
3677 # specified values, the communication continues. Otherwise, it fails. This
3678 # additional check enables the client to verify that the server is authorized
3679 # to run the requested service.
3680 #
3681 # Note that the contents of the server
3682 # certificate&#x27;s subjectAltName field are configured by the
3683 # Public Key Infrastructure which provisions server identities.
3684 #
3685 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
3686 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
3687 # mode).
3688 &quot;A String&quot;,
3689 ],
3690 },
3691 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3692 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
3693 #
3694 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
3695 # If set, lists of backends and health checks must be both empty.
3696 &quot;A String&quot;,
3697 ],
3698 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
3699 #
3700 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
3701 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
3702 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
3703 #
3704 # Only NONE and HEADER_FIELD are supported
3705 # when the backend service is referenced by a URL map that is bound to
3706 # target gRPC proxy that has validateForProxyless field set to true.
3707 #
3708 # For more details, see:
3709 # [Session
3710 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
3711 #
3712 # sessionAffinity cannot be specified with haPolicy.
3713 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
3714 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
3715 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
3716 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
3717 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
3718 # as a count of seconds and fractions of seconds at nanosecond
3719 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
3720 # or &quot;month&quot;. Range is approximately 10,000 years.
3721 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
3722 # Durations less than one second are represented with a 0
3723 # `seconds` field and a positive `nanos` field. Must be from 0
3724 # to 999,999,999 inclusive.
3725 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
3726 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
3727 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
3728 },
3729 },
3730 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
3731 # Currently this is applicable only for Internal TCP/UDP load balancing,
3732 # Internal HTTP(S) load balancing and Traffic Director.
3733 &quot;policy&quot;: &quot;A String&quot;,
3734 },
3735 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
3736 # type of load balancer. For more information see,
3737 # Backend service settings.
3738 # The default is 30 seconds.
3739 # The full range of timeout values allowed goes from 1
3740 # through 2,147,483,647 seconds.
3741 #
3742 # This value can be overridden in the PathMatcher configuration of the
3743 # UrlMap that references this backend service.
3744 #
3745 # Not supported when the backend service is referenced by a URL map that is
3746 # bound to target gRPC proxy that has validateForProxyless field set to true.
3747 # Instead, use maxStreamDuration.
3748 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
3749 # when the backend protocol is SSL, HTTPS or HTTP2.
3750 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
3751 # networksecurity.googleapis.com namespace. Can be used in authenticating
3752 # TLS connections to the backend, as specified by the authenticationMode
3753 # field. Can only be specified if authenticationMode is not NONE.
3754 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
3755 # balancer sends this string as the SNI hostname in the TLS connection to
3756 # the backend, and requires that this string match a Subject Alternative
3757 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
3758 # NEG backend, if the SNI is specified here, the load balancer uses it
3759 # regardless of whether the Regional Internet NEG is specified with FQDN or
3760 # IP address and port. When both sni and subjectAltNames[] are specified,
3761 # the load balancer matches the backend certificate&#x27;s SAN only to
3762 # subjectAltNames[].
3763 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
3764 # verifies during a TLS handshake with the backend. When the server
3765 # presents its X.509 certificate to the Load Balancer, the Load Balancer
3766 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
3767 # match one of the subjectAltNames in the list. This field is limited to 5
3768 # entries. When both sni and subjectAltNames[] are specified, the load
3769 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
3770 { # A Subject Alternative Name that the load balancer matches against the SAN
3771 # field in the TLS certificate provided by the backend, specified as either
3772 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
3773 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
3774 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
3775 },
3776 ],
3777 },
3778 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
3779 {
3780 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
3781 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
3782 # and ForwardingRule.
3783 },
3784 ],
3785 }</pre>
3786 </div>
3787
3788 <div class="method">
3789 <code class="details" id="getEffectiveSecurityPolicies">getEffectiveSecurityPolicies(project, backendService, x__xgafv=None)</code>
3790 <pre>Returns effective security policies applied to this backend service.
3791
3792 Args:
3793 project: string, Project ID for this request. (required)
3794 backendService: string, Name of the Backend Service for this request. (required)
3795 x__xgafv: string, V1 error format.
3796 Allowed values
3797 1 - v1 error format
3798 2 - v2 error format
3799 </pre>
3800 </div>
3801
3802 <div class="method">
3803 <code class="details" id="getHealth">getHealth(project, backendService, body=None, x__xgafv=None)</code>
3804 <pre>Gets the most recent health check results for this
3805 BackendService.
3806
3807 Example request body:
3808
3809 {
3810 &quot;group&quot;: &quot;/zones/us-east1-b/instanceGroups/lb-backend-example&quot;
3811 }
3812
3813 Args:
3814 project: string, A parameter (required)
3815 backendService: string, Name of the BackendService resource to which the queried instance belongs. (required)
3816 body: object, The request body.
3817 The object takes the form of:
3818
3819 {
3820 &quot;group&quot;: &quot;A String&quot;, # A URI referencing one of the instance groups or network endpoint groups
3821 # listed in the backend service.
3822 }
3823
3824 x__xgafv: string, V1 error format.
3825 Allowed values
3826 1 - v1 error format
3827 2 - v2 error format
3828
3829 Returns:
3830 An object of the form:
3831
3832 {
3833 &quot;annotations&quot;: { # Metadata defined as annotations on the network endpoint group.
3834 &quot;a_key&quot;: &quot;A String&quot;,
3835 },
3836 &quot;healthStatus&quot;: [ # Health state of the backend instances or endpoints in requested instance or
3837 # network endpoint group, determined based on configured health checks.
3838 {
3839 &quot;annotations&quot;: { # Metadata defined as annotations for network endpoint.
3840 &quot;a_key&quot;: &quot;A String&quot;,
3841 },
3842 &quot;forwardingRule&quot;: &quot;A String&quot;, # URL of the forwarding rule associated with the health status of the
3843 # instance.
3844 &quot;forwardingRuleIp&quot;: &quot;A String&quot;, # A forwarding rule IP address assigned to this instance.
3845 &quot;healthState&quot;: &quot;A String&quot;, # Health state of the IPv4 address of the instance.
3846 &quot;instance&quot;: &quot;A String&quot;, # URL of the instance resource.
3847 &quot;ipAddress&quot;: &quot;A String&quot;, # For target pool based Network Load Balancing, it indicates the forwarding
3848 # rule&#x27;s IP address assigned to this instance. For other types of load
3849 # balancing, the field indicates VM internal ip.
3850 &quot;ipv6Address&quot;: &quot;A String&quot;,
3851 &quot;ipv6HealthState&quot;: &quot;A String&quot;, # Health state of the IPv6 address of the instance.
3852 &quot;port&quot;: 42, # The named port of the instance group, not necessarily the port that is
3853 # health-checked.
3854 &quot;weight&quot;: &quot;A String&quot;,
3855 &quot;weightError&quot;: &quot;A String&quot;,
3856 },
3857 ],
3858 &quot;kind&quot;: &quot;compute#backendServiceGroupHealth&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#backendServiceGroupHealth for the health of backend
3859 # services.
3860 }</pre>
3861 </div>
3862
3863 <div class="method">
3864 <code class="details" id="getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
3865 <pre>Gets the access control policy for a resource. May be empty if no such
3866 policy or resource exists.
3867
3868 Args:
3869 project: string, Project ID for this request. (required)
3870 resource: string, Name or id of the resource for this request. (required)
3871 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
3872 x__xgafv: string, V1 error format.
3873 Allowed values
3874 1 - v1 error format
3875 2 - v2 error format
3876
3877 Returns:
3878 An object of the form:
3879
3880 { # An Identity and Access Management (IAM) policy, which specifies access
3881 # controls for Google Cloud resources.
3882 #
3883 #
3884 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
3885 # `members`, or principals, to a single `role`. Principals can be user
3886 # accounts, service accounts, Google groups, and domains (such as G Suite). A
3887 # `role` is a named list of permissions; each `role` can be an IAM predefined
3888 # role or a user-created custom role.
3889 #
3890 # For some types of Google Cloud resources, a `binding` can also specify a
3891 # `condition`, which is a logical expression that allows access to a resource
3892 # only if the expression evaluates to `true`. A condition can add constraints
3893 # based on attributes of the request, the resource, or both. To learn which
3894 # resources support conditions in their IAM policies, see the
3895 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3896 #
3897 # **JSON example:**
3898 #
3899 # ```
3900 # {
3901 # &quot;bindings&quot;: [
3902 # {
3903 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
3904 # &quot;members&quot;: [
3905 # &quot;user:[email protected]&quot;,
3906 # &quot;group:[email protected]&quot;,
3907 # &quot;domain:google.com&quot;,
3908 # &quot;serviceAccount:[email protected]&quot;
3909 # ]
3910 # },
3911 # {
3912 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
3913 # &quot;members&quot;: [
3914 # &quot;user:[email protected]&quot;
3915 # ],
3916 # &quot;condition&quot;: {
3917 # &quot;title&quot;: &quot;expirable access&quot;,
3918 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
3919 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
3920 # }
3921 # }
3922 # ],
3923 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
3924 # &quot;version&quot;: 3
3925 # }
3926 # ```
3927 #
3928 # **YAML example:**
3929 #
3930 # ```
3931 # bindings:
3932 # - members:
3933 # - user:[email protected]
3934 # - group:[email protected]
3935 # - domain:google.com
3936 # - serviceAccount:[email protected]
3937 # role: roles/resourcemanager.organizationAdmin
3938 # - members:
3939 # - user:[email protected]
3940 # role: roles/resourcemanager.organizationViewer
3941 # condition:
3942 # title: expirable access
3943 # description: Does not grant access after Sep 2020
3944 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
3945 # etag: BwWWja0YfJA=
3946 # version: 3
3947 # ```
3948 #
3949 # For a description of IAM and its features, see the
3950 # [IAM documentation](https://cloud.google.com/iam/docs/).
3951 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
3952 { # Specifies the audit configuration for a service.
3953 # The configuration determines which permission types are logged, and what
3954 # identities, if any, are exempted from logging.
3955 # An AuditConfig must have one or more AuditLogConfigs.
3956 #
3957 # If there are AuditConfigs for both `allServices` and a specific service,
3958 # the union of the two AuditConfigs is used for that service: the log_types
3959 # specified in each AuditConfig are enabled, and the exempted_members in each
3960 # AuditLogConfig are exempted.
3961 #
3962 # Example Policy with multiple AuditConfigs:
3963 #
3964 # {
3965 # &quot;audit_configs&quot;: [
3966 # {
3967 # &quot;service&quot;: &quot;allServices&quot;,
3968 # &quot;audit_log_configs&quot;: [
3969 # {
3970 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3971 # &quot;exempted_members&quot;: [
3972 # &quot;user:[email protected]&quot;
3973 # ]
3974 # },
3975 # {
3976 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3977 # },
3978 # {
3979 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
3980 # }
3981 # ]
3982 # },
3983 # {
3984 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
3985 # &quot;audit_log_configs&quot;: [
3986 # {
3987 # &quot;log_type&quot;: &quot;DATA_READ&quot;
3988 # },
3989 # {
3990 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
3991 # &quot;exempted_members&quot;: [
3992 # &quot;user:[email protected]&quot;
3993 # ]
3994 # }
3995 # ]
3996 # }
3997 # ]
3998 # }
3999 #
4000 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
4001 # logging. It also exempts `[email protected]` from DATA_READ logging, and
4002 # `[email protected]` from DATA_WRITE logging.
4003 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
4004 { # Provides the configuration for logging a type of permissions.
4005 # Example:
4006 #
4007 # {
4008 # &quot;audit_log_configs&quot;: [
4009 # {
4010 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
4011 # &quot;exempted_members&quot;: [
4012 # &quot;user:[email protected]&quot;
4013 # ]
4014 # },
4015 # {
4016 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
4017 # }
4018 # ]
4019 # }
4020 #
4021 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
4022 # [email protected] from DATA_READ logging.
4023 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
4024 # permission.
4025 # Follows the same format of Binding.members.
4026 &quot;A String&quot;,
4027 ],
4028 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
4029 },
4030 ],
4031 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
4032 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
4033 # `allServices` is a special value that covers all services.
4034 },
4035 ],
4036 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
4037 # may specify a `condition` that determines how and when the `bindings` are
4038 # applied. Each of the `bindings` must contain at least one principal.
4039 #
4040 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
4041 # of these principals can be Google groups. Each occurrence of a principal
4042 # counts towards these limits. For example, if the `bindings` grant 50
4043 # different roles to `user:[email protected]`, and not to any other
4044 # principal, then you can add another 1,450 principals to the `bindings` in
4045 # the `Policy`.
4046 { # Associates `members`, or principals, with a `role`.
4047 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
4048 #
4049 # If the condition evaluates to `true`, then this binding applies to the
4050 # current request.
4051 #
4052 # If the condition evaluates to `false`, then this binding does not apply to
4053 # the current request. However, a different role binding might grant the same
4054 # role to one or more of the principals in this binding.
4055 #
4056 # To learn which resources support conditions in their IAM policies, see the
4057 # [IAM
4058 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
4059 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
4060 # are documented at https://github.com/google/cel-spec.
4061 #
4062 # Example (Comparison):
4063 #
4064 # title: &quot;Summary size limit&quot;
4065 # description: &quot;Determines if a summary is less than 100 chars&quot;
4066 # expression: &quot;document.summary.size() &lt; 100&quot;
4067 #
4068 # Example (Equality):
4069 #
4070 # title: &quot;Requestor is owner&quot;
4071 # description: &quot;Determines if requestor is the document owner&quot;
4072 # expression: &quot;document.owner == request.auth.claims.email&quot;
4073 #
4074 # Example (Logic):
4075 #
4076 # title: &quot;Public documents&quot;
4077 # description: &quot;Determine whether the document should be publicly visible&quot;
4078 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
4079 #
4080 # Example (Data Manipulation):
4081 #
4082 # title: &quot;Notification string&quot;
4083 # description: &quot;Create a notification string with a timestamp.&quot;
4084 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
4085 #
4086 # The exact variables and functions that may be referenced within an expression
4087 # are determined by the service that evaluates it. See the service
4088 # documentation for additional information.
4089 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
4090 # describes the expression, e.g. when hovered over it in a UI.
4091 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
4092 # syntax.
4093 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
4094 # reporting, e.g. a file name and a position in the file.
4095 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
4096 # its purpose. This can be used e.g. in UIs which allow to enter the
4097 # expression.
4098 },
4099 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
4100 # `members` can have the following values:
4101 #
4102 # * `allUsers`: A special identifier that represents anyone who is
4103 # on the internet; with or without a Google account.
4104 #
4105 # * `allAuthenticatedUsers`: A special identifier that represents anyone
4106 # who is authenticated with a Google account or a service account.
4107 # Does not include identities that come from external identity providers
4108 # (IdPs) through identity federation.
4109 #
4110 # * `user:{emailid}`: An email address that represents a specific Google
4111 # account. For example, `[email protected]` .
4112 #
4113 #
4114 # * `serviceAccount:{emailid}`: An email address that represents a Google
4115 # service account. For example,
4116 # `[email protected]`.
4117 #
4118 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
4119 # identifier for a
4120 # [Kubernetes service
4121 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
4122 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
4123 #
4124 # * `group:{emailid}`: An email address that represents a Google group.
4125 # For example, `[email protected]`.
4126 #
4127 #
4128 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
4129 # users of that domain. For example, `google.com` or `example.com`.
4130 #
4131 #
4132 #
4133 #
4134 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
4135 # A single identity in a workforce identity pool.
4136 #
4137 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
4138 # All workforce identities in a group.
4139 #
4140 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
4141 # All workforce identities with a specific attribute value.
4142 #
4143 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
4144 # All identities in a workforce identity pool.
4145 #
4146 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
4147 # A single identity in a workload identity pool.
4148 #
4149 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
4150 # A workload identity pool group.
4151 #
4152 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
4153 # All identities in a workload identity pool with a certain attribute.
4154 #
4155 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
4156 # All identities in a workload identity pool.
4157 #
4158 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
4159 # identifier) representing a user that has been recently deleted. For
4160 # example, `[email protected]?uid=123456789012345678901`. If the user is
4161 # recovered, this value reverts to `user:{emailid}` and the recovered user
4162 # retains the role in the binding.
4163 #
4164 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
4165 # unique identifier) representing a service account that has been recently
4166 # deleted. For example,
4167 # `[email protected]?uid=123456789012345678901`.
4168 # If the service account is undeleted, this value reverts to
4169 # `serviceAccount:{emailid}` and the undeleted service account retains the
4170 # role in the binding.
4171 #
4172 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
4173 # identifier) representing a Google group that has been recently
4174 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
4175 # the group is recovered, this value reverts to `group:{emailid}` and the
4176 # recovered group retains the role in the binding.
4177 #
4178 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
4179 # Deleted single identity in a workforce identity pool. For example,
4180 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
4181 &quot;A String&quot;,
4182 ],
4183 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
4184 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
4185 #
4186 # For an overview of the IAM roles and permissions, see the
4187 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
4188 # a list of the available pre-defined roles, see
4189 # [here](https://cloud.google.com/iam/docs/understanding-roles).
4190 },
4191 ],
4192 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
4193 # prevent simultaneous updates of a policy from overwriting each other.
4194 # It is strongly suggested that systems make use of the `etag` in the
4195 # read-modify-write cycle to perform policy updates in order to avoid race
4196 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
4197 # systems are expected to put that etag in the request to `setIamPolicy` to
4198 # ensure that their change will be applied to the same version of the policy.
4199 #
4200 # **Important:** If you use IAM Conditions, you must include the `etag` field
4201 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
4202 # you to overwrite a version `3` policy with a version `1` policy, and all of
4203 # the conditions in the version `3` policy are lost.
4204 &quot;version&quot;: 42, # Specifies the format of the policy.
4205 #
4206 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
4207 # are rejected.
4208 #
4209 # Any operation that affects conditional role bindings must specify version
4210 # `3`. This requirement applies to the following operations:
4211 #
4212 # * Getting a policy that includes a conditional role binding
4213 # * Adding a conditional role binding to a policy
4214 # * Changing a conditional role binding in a policy
4215 # * Removing any role binding, with or without a condition, from a policy
4216 # that includes conditions
4217 #
4218 # **Important:** If you use IAM Conditions, you must include the `etag` field
4219 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
4220 # you to overwrite a version `3` policy with a version `1` policy, and all of
4221 # the conditions in the version `3` policy are lost.
4222 #
4223 # If a policy does not include any conditions, operations on that policy may
4224 # specify any valid version or leave the field unset.
4225 #
4226 # To learn which resources support conditions in their IAM policies, see the
4227 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
4228 }</pre>
4229 </div>
4230
4231 <div class="method">
4232 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code>
4233 <pre>Creates a BackendService resource in the specified project using
4234 the data included in the request. For more information, see
4235 Backend services overview.
4236
4237 Args:
4238 project: string, Project ID for this request. (required)
4239 body: object, The request body.
4240 The object takes the form of:
4241
4242 { # Represents a Backend Service resource.
4243 #
4244 # A backend service defines how Google Cloud load balancers distribute traffic.
4245 # The backend service configuration contains a set of values, such as the
4246 # protocol used to connect to backends, various distribution and session
4247 # settings, health checks, and timeouts. These settings provide fine-grained
4248 # control over how your load balancer behaves. Most of the settings have
4249 # default values that allow for easy configuration if you need to get started
4250 # quickly.
4251 #
4252 # Backend services in Google Compute Engine can be either regionally or
4253 # globally scoped.
4254 #
4255 # * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices)
4256 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices)
4257 #
4258 # For more information, seeBackend
4259 # Services.
4260 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
4261 # Load Balancers and Traffic Director and requires
4262 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
4263 #
4264 # If set to 0, the cookie is non-persistent and lasts only until
4265 # the end of the browser session (or equivalent). The maximum allowed value
4266 # is two weeks (1,209,600).
4267 #
4268 # Not supported when the backend service is referenced by a URL map that is
4269 # bound to target gRPC proxy that has validateForProxyless field set to true.
4270 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
4271 { # Message containing information of one individual backend.
4272 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
4273 # handle additional traffic or is fully loaded. For usage guidelines, see
4274 # Connection balancing mode.
4275 #
4276 # Backends must use compatible balancing modes. For more information, see
4277 # Supported balancing modes and target capacity settings and
4278 # Restrictions and guidance for instance groups.
4279 #
4280 # Note: Currently, if you use the API to configure incompatible balancing
4281 # modes, the configuration might be accepted even though it has no impact
4282 # and is ignored. Specifically, Backend.maxUtilization is ignored when
4283 # Backend.balancingMode is RATE. In the future, this incompatible combination
4284 # will be rejected.
4285 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
4286 # mode.
4287 # The default value is 1, which means the group serves up to
4288 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
4289 # completely drained, offering 0% of its available capacity. The valid ranges
4290 # are 0.0 and [0.1,1.0].
4291 # You cannot configure a setting larger than 0 and smaller than0.1.
4292 # You cannot configure a setting of 0 when there is only one
4293 # backend attached to the backend service.
4294 #
4295 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
4296 # internet NEGs, regional serverless NEGs, and PSC NEGs.
4297 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
4298 # BalancingMode.
4299 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
4300 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
4301 # Monitoring, but is not used for load balancing.
4302 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
4303 # balancing mode. The valid range is [0.0, 1.0].
4304 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
4305 # long and match the regular expression
4306 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
4307 # first character must be a lowercase letter, and all following
4308 # characters must be a dash, period, underscore, lowercase letter, or
4309 # digit, except the last character, which cannot be a dash, period, or
4310 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
4311 # field can only be used for a global or regional backend service with the
4312 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
4313 },
4314 ],
4315 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
4316 # create the resource.
4317 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
4318 # failover backend can be configured for a given BackendService.
4319 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
4320 # group or network endpoint
4321 # group (NEG) resource. To determine what types of backends a load
4322 # balancer supports, see the [Backend services
4323 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
4324 #
4325 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
4326 # or NEG. Partial URLs are not supported.
4327 #
4328 # If haPolicy is specified, backends must refer to NEG resources of type
4329 # GCE_VM_IP.
4330 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
4331 # guidelines, seeConnection
4332 # balancing mode and Utilization
4333 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
4334 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
4335 # guidelines, seeConnection
4336 # balancing mode and Utilization
4337 # balancing mode.
4338 #
4339 # Not available if the backend&#x27;s balancingMode isRATE.
4340 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
4341 # For usage guidelines, seeConnection
4342 # balancing mode and Utilization
4343 # balancing mode.
4344 #
4345 # Not available if the backend&#x27;s balancingMode isRATE.
4346 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
4347 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
4348 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
4349 # Not available if backend&#x27;s balancingMode is RATE
4350 # or CONNECTION.
4351 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
4352 # Not available if backend&#x27;s balancingMode is RATE
4353 # or CONNECTION.
4354 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
4355 # usage guidelines, seeRate
4356 # balancing mode and Utilization
4357 # balancing mode.
4358 #
4359 # Not available if the backend&#x27;s balancingMode isCONNECTION.
4360 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
4361 # guidelines, seeRate
4362 # balancing mode and Utilization
4363 # balancing mode.
4364 #
4365 # Not available if the backend&#x27;s balancingMode isCONNECTION.
4366 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
4367 # guidelines, seeRate
4368 # balancing mode and Utilization
4369 # balancing mode.
4370 #
4371 # Not available if the backend&#x27;s balancingMode isCONNECTION.
4372 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
4373 #
4374 # For usage guidelines, seeUtilization
4375 # balancing mode.
4376 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
4377 # the backend.
4378 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
4379 },
4380 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
4381 # sending traffic to backends with default preference. The possible values
4382 # are:
4383 #
4384 # - PREFERRED: Backends with this preference level will be
4385 # filled up to their capacity limits first, based on RTT.
4386 # - DEFAULT: If preferred backends don&#x27;t have enough
4387 # capacity, backends in this layer would be used and traffic would be
4388 # assigned based on the load balancing algorithm you use. This is the
4389 # default
4390 &quot;trafficDuration&quot;: &quot;A String&quot;,
4391 },
4392 ],
4393 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
4394 # specified load balancer types.
4395 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
4396 # Pragma or Authorization headers. Up to 5 headers can be specified.
4397 # The cache is bypassed for all cdnPolicy.cacheMode settings.
4398 { # Bypass the cache when the specified request headers are present,
4399 # e.g. Pragma or Authorization headers. Values are case insensitive.
4400 # The presence of such a header overrides the cache_mode setting.
4401 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
4402 # Values are case-insensitive.
4403 },
4404 ],
4405 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
4406 # CDN.
4407 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
4408 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
4409 &quot;A String&quot;,
4410 ],
4411 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
4412 # The name=value pair will be used in the cache key Cloud CDN generates.
4413 &quot;A String&quot;,
4414 ],
4415 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
4416 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
4417 # query_string_whitelist and query_string_blacklist. If neither is set, the
4418 # entire query string will be included. If false, the query string will be
4419 # excluded from the cache key entirely.
4420 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
4421 # parameters will be included. Either specify query_string_whitelist or
4422 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
4423 # not treated as delimiters.
4424 &quot;A String&quot;,
4425 ],
4426 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
4427 # parameters will be excluded. Either specify query_string_whitelist or
4428 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
4429 # not treated as delimiters.
4430 &quot;A String&quot;,
4431 ],
4432 },
4433 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
4434 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
4435 # headers to cache content. Responses without these headers will not be
4436 # cached at Google&#x27;s edge, and will require a full trip to the origin on
4437 # every request, potentially impacting performance and increasing load on
4438 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
4439 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
4440 # Warning: this may result in Cloud CDN caching private,
4441 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
4442 # including common image formats, media (video and audio), and web assets
4443 # (JavaScript and CSS). Requests and responses that are marked as
4444 # uncacheable, as well as dynamic content (including HTML), will not be
4445 # cached.
4446 #
4447 # If no value is provided for cdnPolicy.cacheMode, it defaults
4448 # to CACHE_ALL_STATIC.
4449 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
4450 # used to clamp the max-age (or Expires) value sent to the client. With
4451 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
4452 # response max-age directive, along with a &quot;public&quot; directive. For
4453 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
4454 # from the origin (if specified), or else sets the response max-age
4455 # directive to the lesser of the client_ttl and default_ttl, and also
4456 # ensures a &quot;public&quot; cache-control directive is present.
4457 # If a client TTL is not specified, a default value (1 hour) will be used.
4458 # The maximum allowed value is 31,622,400s (1 year).
4459 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
4460 # responses that do not have an existing valid TTL (max-age or s-maxage).
4461 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
4462 # The value of defaultTTL cannot be set to a value greater than that of
4463 # maxTTL, but can be equal.
4464 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
4465 # will overwrite the TTL set in all responses. The maximum allowed value is
4466 # 31,622,400s (1 year), noting that infrequently accessed objects may be
4467 # evicted from the cache before the defined TTL.
4468 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
4469 # origin.
4470 # Cache directives that attempt to set a max-age or s-maxage higher than
4471 # this, or an Expires header more than maxTTL seconds in the future will
4472 # be capped at the value of maxTTL, as if it were the value of an
4473 # s-maxage Cache-Control directive.
4474 # Headers sent to the client will not be modified.
4475 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
4476 # The maximum allowed value is 31,622,400s (1 year), noting that
4477 # infrequently accessed objects may be evicted from the cache before
4478 # the defined TTL.
4479 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
4480 # to apply fine-grained caching for common errors or redirects.
4481 # This can reduce the load on your origin and improve end-user
4482 # experience by reducing response latency.
4483 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
4484 # negative caching applies to responses with the specified response code
4485 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
4486 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
4487 # to all responses with the specified response code, and override any
4488 # caching headers.
4489 # By default, Cloud CDN will apply the following default TTLs to these
4490 # status codes:
4491 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
4492 # HTTP 404 (Not Found), 410 (Gone),
4493 # 451 (Unavailable For Legal Reasons): 120s
4494 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
4495 # These defaults can be overridden in negative_caching_policy.
4496 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
4497 # negative_caching must be enabled to configure negative_caching_policy.
4498 # Omitting the policy and leaving negative_caching enabled will use
4499 # Cloud CDN&#x27;s default cache TTLs.
4500 # Note that when specifying an explicit negative_caching_policy, you
4501 # should take care to specify a cache TTL for all response codes
4502 # that you wish to cache. Cloud CDN will not apply any default
4503 # negative caching when a policy exists.
4504 { # Specify CDN TTLs for response error codes.
4505 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
4506 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
4507 # specified as values, and you cannot specify a status code more than
4508 # once.
4509 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
4510 # corresponding status code.
4511 # The maximum allowed value is 1800s (30 minutes), noting that
4512 # infrequently accessed objects may be evicted from the cache before the
4513 # defined TTL.
4514 },
4515 ],
4516 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
4517 # requests into a small number of requests to the origin.
4518 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
4519 # content with the origin, or when an error is encountered when refreshing
4520 # the cache.
4521 # This setting defines the default &quot;max-stale&quot; duration for any cached
4522 # responses that do not specify a max-stale directive. Stale responses that
4523 # exceed the TTL configured here will not be served. The default limit
4524 # (max-stale) is 86400s (1 day), which will allow stale content to be
4525 # served up to this limit beyond the max-age (or s-maxage) of a cached
4526 # response.
4527 # The maximum allowed value is 604800 (1 week).
4528 # Set this to zero (0) to disable serve-while-stale.
4529 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
4530 # considered fresh. After this time period, the response will be
4531 # revalidated before being served. Defaults to 1hr (3600s). When serving
4532 # responses to signed URL requests, Cloud CDN will internally behave as
4533 # though all responses from this backend had a &quot;Cache-Control:
4534 # public, max-age=[TTL]&quot; header, regardless of any existing
4535 # Cache-Control header. The actual headers served in responses will not be
4536 # altered.
4537 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
4538 &quot;A String&quot;,
4539 ],
4540 },
4541 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
4542 # backend service.
4543 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
4544 # there is no limit.
4545 #
4546 # Not supported when the backend service is referenced by a URL map that is
4547 # bound to target gRPC proxy that has validateForProxyless field set to true.
4548 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
4549 # not specified, there is no limit.
4550 #
4551 # Not supported when the backend service is referenced by a URL map that is
4552 # bound to target gRPC proxy that has validateForProxyless field set to true.
4553 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
4554 # service. If not specified, there is no limit.
4555 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
4556 # This parameter is respected by both the HTTP/1.1 and HTTP/2
4557 # implementations. If not specified, there is no limit. Setting this
4558 # parameter to 1 will effectively disable keep alive.
4559 #
4560 # Not supported when the backend service is referenced by a URL map that is
4561 # bound to target gRPC proxy that has validateForProxyless field set to true.
4562 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
4563 # not specified, the default is 1.
4564 #
4565 # Not supported when the backend service is referenced by a URL map that is
4566 # bound to target gRPC proxy that has validateForProxyless field set to true.
4567 },
4568 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
4569 # the client&#x27;s Accept-Encoding header.
4570 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
4571 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
4572 # instance. For supported load balancers and protocols, as described inEnabling
4573 # connection draining.
4574 },
4575 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
4576 # tracking policy settings are only available for external passthrough
4577 # Network Load Balancers and internal passthrough Network Load Balancers.
4578 #
4579 # connectionTrackingPolicy cannot be specified with haPolicy.
4580 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
4581 # value is DEFAULT_FOR_PROTOCOL.
4582 #
4583 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
4584 # persist on unhealthy backends only for connection-oriented protocols
4585 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
4586 # Affinity is configured for 5-tuple. They do not persist forUDP.
4587 #
4588 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
4589 # the existing connections on the unhealthy backend are never persisted on
4590 # the unhealthy backend. They are always diverted to newly selected healthy
4591 # backends (unless all backends are unhealthy).
4592 #
4593 # If set to ALWAYS_PERSIST, existing connections always
4594 # persist on unhealthy backends regardless of protocol and session
4595 # affinity. It is generally not recommended to use this mode overriding the
4596 # default.
4597 #
4598 # For more details, see [Connection Persistence for Network Load
4599 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
4600 # and [Connection Persistence for Internal TCP/UDP Load
4601 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
4602 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
4603 # Balancers. This option is not available publicly.
4604 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
4605 # matching traffic (in seconds).
4606 #
4607 # For internal passthrough Network Load Balancers:
4608 #
4609 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
4610 # - It can be set only if Connection Tracking is less than 5-tuple
4611 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
4612 # Mode is PER_SESSION).
4613 #
4614 #
4615 #
4616 # For external passthrough Network Load Balancers the default is 60
4617 # seconds. This option is not available publicly.
4618 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
4619 # options:
4620 #
4621 # - PER_CONNECTION: This is the default mode. The Connection
4622 # Tracking is performed as per the Connection Key (default Hash Method) for
4623 # the specific protocol.
4624 # - PER_SESSION: The Connection Tracking is performed as per
4625 # the configured Session Affinity. It matches the configured Session
4626 # Affinity.
4627 #
4628 #
4629 #
4630 # For more details, see [Tracking Mode for Network Load
4631 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
4632 # and [Tracking Mode for Internal TCP/UDP Load
4633 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
4634 },
4635 &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
4636 # affinity based on HTTP headers, cookies or other properties. This load
4637 # balancing policy is applicable only for HTTP connections. The affinity to a
4638 # particular destination host will be lost when one or more hosts are
4639 # added/removed from the destination service. This field specifies parameters
4640 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
4641 #
4642 # This field is applicable to either:
4643 #
4644 # - A regional backend service with the service protocol set to HTTP,
4645 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
4646 # INTERNAL_MANAGED.
4647 # - A global backend service with the
4648 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
4649 &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
4650 # be used as the hash key for the consistent hash load balancer. If the
4651 # cookie is not present, it will be generated. This field is applicable if
4652 # the sessionAffinity is set to HTTP_COOKIE.
4653 #
4654 # Not supported when the backend service is referenced by a URL map that is
4655 # bound to target gRPC proxy that has validateForProxyless field set to true.
4656 # for load balancing policies that use a consistent hash.
4657 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
4658 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
4659 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
4660 # as a count of seconds and fractions of seconds at nanosecond
4661 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
4662 # or &quot;month&quot;. Range is approximately 10,000 years.
4663 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
4664 # Durations less than one second are represented with a 0
4665 # `seconds` field and a positive `nanos` field. Must be from 0
4666 # to 999,999,999 inclusive.
4667 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
4668 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
4669 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
4670 },
4671 },
4672 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
4673 # applicable if the sessionAffinity is set toHEADER_FIELD.
4674 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
4675 # 1024. Larger ring sizes result in more granular load distributions. If the
4676 # number of hosts in the load balancing pool is larger than the ring size,
4677 # each host will be assigned a single virtual node.
4678 },
4679 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
4680 # text format.
4681 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
4682 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
4683 # locality_lb_policy.
4684 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
4685 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
4686 # long and match the regular expression
4687 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
4688 # first character must be a lowercase letter, and all following
4689 # characters must be a dash, period, underscore, lowercase letter, or
4690 # digit, except the last character, which cannot be a dash, period, or
4691 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
4692 # field can only be used for a global or regional backend service with the
4693 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
4694 },
4695 ],
4696 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
4697 # custom
4698 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
4699 &quot;A String&quot;,
4700 ],
4701 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
4702 # custom
4703 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
4704 &quot;A String&quot;,
4705 ],
4706 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
4707 # create the resource.
4708 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
4709 # this backend service.
4710 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
4711 # global external Application Load Balancer.
4712 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
4713 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
4714 #
4715 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
4716 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
4717 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
4718 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
4719 # externalManagedMigrationTestingPercentage.
4720 #
4721 # Rolling back a migration requires the states to be set in reverse order. So
4722 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
4723 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
4724 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
4725 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
4726 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
4727 # external Application Load Balancer.
4728 #
4729 # The value of this field must be in the range [0, 100].
4730 #
4731 # Session affinity options will slightly affect this routing behavior, for
4732 # more details, see:Session
4733 # Affinity.
4734 #
4735 # This value can only be set if the loadBalancingScheme in the BackendService
4736 # is set to EXTERNAL (when using the classic Application Load Balancer) and
4737 # the migration state is TEST_BY_PERCENTAGE.
4738 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
4739 # as a backup (failover) backend.
4740 # For load balancers that have configurable failover:
4741 # [Internal passthrough Network Load
4742 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
4743 # and [external passthrough Network Load
4744 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
4745 #
4746 # failoverPolicy cannot be specified with haPolicy.
4747 # failover:
4748 # [Internal passthrough Network Load
4749 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
4750 # and [external passthrough
4751 # Network Load
4752 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
4753 # On failover or failback, this field indicates whether connection draining
4754 # will be honored. Google Cloud has a fixed connection draining timeout of
4755 # 10 minutes. A setting of true terminates existing TCP
4756 # connections to the active pool during failover and failback, immediately
4757 # draining traffic. A setting of false allows existing TCP
4758 # connections to persist, even on VMs no longer in the active pool, for up
4759 # to the duration of the connection draining timeout (10 minutes).
4760 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
4761 #
4762 # The default is false.
4763 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
4764 # load balancer are dropped when all primary and all backup backend VMs are
4765 # unhealthy.If set to false, connections are distributed
4766 # among all primary VMs when all primary and all backup backend VMs are
4767 # unhealthy.
4768 # For load balancers that have configurable
4769 # failover:
4770 # [Internal passthrough
4771 # Network Load
4772 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
4773 # and [external passthrough
4774 # Network Load
4775 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
4776 # The default is false.
4777 &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
4778 # failover when the number of healthy primary VMs equals zero.
4779 # For all other values, the load balancer performs a failover when the
4780 # total number of healthy primary VMs is less than this ratio.
4781 # For load balancers that have configurable
4782 # failover:
4783 # [Internal TCP/UDP Load
4784 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
4785 # and [external TCP/UDP Load
4786 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
4787 },
4788 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
4789 # This field is used in optimistic locking. This field will be ignored when
4790 # inserting a BackendService. An up-to-date fingerprint must be provided in
4791 # order to update the BackendService, otherwise the request will
4792 # fail with error 412 conditionNotMet.
4793 #
4794 # To see the latest fingerprint, make a get() request to
4795 # retrieve a BackendService.
4796 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
4797 # Protocol Forwarding.
4798 #
4799 # The backends of this regional backend service must only specify zonal
4800 # network endpoint groups (NEGs) of type GCE_VM_IP.
4801 #
4802 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
4803 # regional backend service must set the network field. All zonal NEGs must
4804 # belong to the same network. However, individual NEGs can
4805 # belong to different subnetworks of that network.
4806 #
4807 # When haPolicy is specified, the set of attached network endpoints across
4808 # all backends comprise an High Availability domain from which one endpoint
4809 # is selected as the active endpoint (the leader) that receives all
4810 # traffic.
4811 #
4812 # haPolicy can be added only at backend service creation time. Once set up,
4813 # it cannot be deleted.
4814 #
4815 # Note that haPolicy is not for load balancing, and therefore cannot be
4816 # specified with sessionAffinity, connectionTrackingPolicy, and
4817 # failoverPolicy.
4818 #
4819 # haPolicy requires customers to be responsible for tracking backend
4820 # endpoint health and electing a leader among the healthy endpoints.
4821 # Therefore, haPolicy cannot be specified with healthChecks.
4822 #
4823 # haPolicy can only be specified for External Passthrough Network Load
4824 # Balancers and Internal Passthrough Network Load Balancers.
4825 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
4826 # achieve it.
4827 #
4828 # Supported values are:
4829 #
4830 # - DISABLED: Fast IP Move is disabled. You can only use the
4831 # haPolicy.leader API to update the leader.
4832 # - &gt;GARP_RA: Provides a method to very quickly define a new network
4833 # endpoint as the leader. This method is faster than updating the leader
4834 # using the haPolicy.leader API. Fast IP move works as follows: The VM
4835 # hosting the network endpoint that should become the new leader sends
4836 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
4837 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
4838 # temporarily associates the forwarding rule IP address with that VM, and
4839 # both new and in-flight packets are quickly delivered to that VM.
4840 #
4841 #
4842 #
4843 # Note the important properties of the Fast IP Move functionality:
4844 #
4845 # - The GARP/RA-initiated re-routing stays active for approximately 20
4846 # minutes. After triggering fast failover, you must also
4847 # appropriately set the haPolicy.leader.
4848 # - The new leader instance should continue to send GARP/RA packets
4849 # periodically every 10 seconds until at least 10 minutes after updating
4850 # the haPolicy.leader (but stop immediately if it is no longer the leader).
4851 # - After triggering a fast failover, we recommend that you wait at least
4852 # 3 seconds before sending another GARP/RA packet from a different VM
4853 # instance to avoid race conditions.
4854 # - Don&#x27;t send GARP/RA packets from different VM
4855 # instances at the same time. If multiple instances continue to send
4856 # GARP/RA packets, traffic might be routed to different destinations in an
4857 # alternating order. This condition ceases when a single instance
4858 # issues a GARP/RA packet.
4859 # - The GARP/RA request always takes priority over the leader API.
4860 # Using the haPolicy.leader API to change the leader to a different
4861 # instance will have no effect until the GARP/RA request becomes
4862 # inactive.
4863 # - The GARP/RA packets should follow the GARP/RA
4864 # Packet Specifications..
4865 # - When multiple forwarding rules refer to a regional backend service,
4866 # you need only send a GARP or RA packet for a single forwarding rule
4867 # virtual IP. The virtual IPs for all forwarding rules targeting the same
4868 # backend service will also be moved to the sender of the GARP or RA
4869 # packet.
4870 #
4871 #
4872 #
4873 # The following are the Fast IP Move limitations (that is, when fastIPMove
4874 # is not DISABLED):
4875 #
4876 # - Multiple forwarding rules cannot use the same IP address if one of
4877 # them refers to a regional backend service with fastIPMove.
4878 # - The regional backend service must set the network field, and all
4879 # NEGs must belong to that network. However, individual
4880 # NEGs can belong to different subnetworks of that network.
4881 # - The maximum number of network endpoints across all backends of a
4882 # backend service with fastIPMove is 32.
4883 # - The maximum number of backend services with fastIPMove that can have
4884 # the same network endpoint attached to one of its backends is 64.
4885 # - The maximum number of backend services with fastIPMove in a VPC in a
4886 # region is 64.
4887 # - The network endpoints that are attached to a backend of a backend
4888 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
4889 # - Traffic directed to the leader by a static route next hop will not be
4890 # redirected to a new leader by fast failover. Such traffic will only be
4891 # redirected once an haPolicy.leader update has taken effect. Only traffic
4892 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
4893 # fast failover.
4894 #
4895 #
4896 # haPolicy.fastIPMove can be set only at backend service creation time.
4897 # Once set, it cannot be updated.
4898 #
4899 # By default, fastIpMove is set to DISABLED.
4900 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
4901 # this service as the active endpoint (the leader) that receives all
4902 # traffic.
4903 #
4904 # When the leader changes, there is no connection draining to persist
4905 # existing connections on the old leader.
4906 #
4907 # You are responsible for selecting a suitable endpoint as the
4908 # leader. For example, preferring a healthy endpoint over unhealthy ones.
4909 # Note that this service does not track backend endpoint health, and
4910 # selects the configured leader unconditionally.
4911 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
4912 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
4913 # that the leader is attached to.
4914 #
4915 # The leader&#x27;s backendGroup must already be specified as a backend of
4916 # this backend service. Removing a backend that is designated as the
4917 # leader&#x27;s backendGroup is not permitted.
4918 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
4919 # designated as the leader.
4920 #
4921 # This network endpoint cannot be detached from the NEG specified in
4922 # the haPolicy.leader.backendGroup until the leader is updated with
4923 # another network endpoint, or the leader is removed from the haPolicy.
4924 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
4925 # instance must already be attached to the NEG specified in the
4926 # haPolicy.leader.backendGroup.
4927 #
4928 # The name must be 1-63 characters long, and comply with RFC1035.
4929 # Authorization requires the following IAM permission on the
4930 # specified resource instance: compute.instances.use
4931 },
4932 },
4933 },
4934 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
4935 # httpsHealthChecks (legacy) resource for health checking this backend
4936 # service. Not all backend services support legacy health checks. See
4937 # Load balancer guide. Currently, at most one health check can be
4938 # specified for each backend service. Backend services with
4939 # instance group or zonal NEG backends must have a health check unless
4940 # haPolicy is specified. Backend services with internet or serverless NEG
4941 # backends must not have a health check.
4942 #
4943 # healthChecks[] cannot be specified with haPolicy.
4944 &quot;A String&quot;,
4945 ],
4946 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
4947 # Not available for internal passthrough Network Load Balancers and external
4948 # passthrough Network Load Balancers.
4949 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
4950 # incoming requests.
4951 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
4952 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
4953 # For security reasons, this value cannot be retrieved via the API.
4954 # Instead, the SHA-256 hash of the value is returned in the
4955 # oauth2ClientSecretSha256 field.
4956 #
4957 # @InputOnly
4958 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
4959 },
4960 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
4961 # defined by the server.
4962 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
4963 # from the client to the backend for proxyless gRPC).
4964 # The possible values are:
4965 #
4966 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
4967 # backend service (Instance Group, Managed Instance Group, Network Endpoint
4968 # Group), regardless of traffic from the client to the proxy. Only IPv4
4969 # health checks are used to check the health of the backends. This is the
4970 # default setting.
4971 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
4972 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
4973 # address).
4974 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
4975 # backend service (Instance Group, Managed Instance Group, Network Endpoint
4976 # Group), regardless of traffic from the client to the proxy. Only IPv6
4977 # health checks are used to check the health of the backends.
4978 #
4979 #
4980 #
4981 # This field is applicable to either:
4982 #
4983 # - Advanced global external Application Load Balancer (load balancing
4984 # scheme EXTERNAL_MANAGED),
4985 # - Regional external Application Load
4986 # Balancer,
4987 # - Internal proxy Network Load Balancer (load balancing
4988 # scheme INTERNAL_MANAGED),
4989 # - Regional internal Application Load
4990 # Balancer (load balancing scheme INTERNAL_MANAGED),
4991 # - Traffic
4992 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
4993 # INTERNAL_SELF_MANAGED).
4994 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
4995 # for backend services.
4996 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
4997 # created for one type of load balancer cannot be used with another.
4998 # For more information, refer toChoosing
4999 # a load balancer.
5000 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
5001 # preference. When you use localityLbPolicies, you must set at least one
5002 # value for either the localityLbPolicies[].policy or the
5003 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
5004 # value set in the localityLbPolicy field.
5005 #
5006 # For an example of how to use this field, seeDefine
5007 # a list of preferred policies.
5008 #
5009 # Caution: This field and its children are intended for use in a service mesh
5010 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
5011 # that have this configuration.
5012 { # Container for either a built-in LB policy supported by gRPC or Envoy or
5013 # a custom one implemented by the end user.
5014 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
5015 # deployed with the client.
5016 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
5017 # by a locally installed custom policy implementation.
5018 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
5019 #
5020 # The value should match the name of a custom implementation registered
5021 # on the gRPC clients. It should follow protocol buffer message naming
5022 # conventions and include the full path (for example,
5023 # myorg.CustomLbPolicy). The maximum length is 256 characters.
5024 #
5025 # Do not specify the same custom policy more than once for a
5026 # backend. If you do, the configuration is rejected.
5027 #
5028 # For an example of how to use this field, seeUse
5029 # a custom policy.
5030 },
5031 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
5032 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
5033 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
5034 # about these values, see the description of localityLbPolicy.
5035 #
5036 # Do not specify the same policy more than once for a
5037 # backend. If you do, the configuration is rejected.
5038 },
5039 },
5040 ],
5041 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
5042 # possible values are:
5043 #
5044 # - ROUND_ROBIN: This is a simple policy in which each healthy
5045 # backend is selected in round robin order. This is the default.
5046 # - LEAST_REQUEST: An O(1) algorithm which
5047 # selects two random healthy hosts and picks the host which has fewer active
5048 # requests.
5049 # - RING_HASH: The ring/modulo hash load balancer implements
5050 # consistent hashing to backends. The algorithm has the property that the
5051 # addition/removal of a host from a set of N hosts only affects 1/N of the
5052 # requests.
5053 # - RANDOM: The load balancer selects a random healthy
5054 # host.
5055 # - ORIGINAL_DESTINATION: Backend host is selected
5056 # based on the client connection metadata, i.e., connections are opened to
5057 # the same address as the destination address of the incoming connection
5058 # before the connection was redirected to the load balancer.
5059 # - MAGLEV: used as a drop in replacement for the ring hash
5060 # load balancer. Maglev is not as stable as ring hash but has faster table
5061 # lookup build times and host selection times. For more information about
5062 # Maglev, see Maglev:
5063 # A Fast and Reliable Software Network Load Balancer.
5064 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
5065 # Load Balancing using weights computed from Backend reported Custom Metrics.
5066 # If set, the Backend Service responses are expected to contain non-standard
5067 # HTTP response header field Endpoint-Load-Metrics. The reported
5068 # metrics to use for computing the weights are specified via thecustomMetrics field.
5069 #
5070 # This field is applicable to either:
5071 # - A regional backend service with the service protocol set to HTTP,
5072 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
5073 # INTERNAL_MANAGED.
5074 # - A global backend service with the
5075 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
5076 # EXTERNAL_MANAGED.
5077 #
5078 #
5079 # If sessionAffinity is not configured—that is, if session
5080 # affinity remains at the default value of NONE—then the
5081 # default value for localityLbPolicy
5082 # is ROUND_ROBIN. If session affinity is set to a value other
5083 # than NONE,
5084 # then the default value for localityLbPolicy isMAGLEV.
5085 #
5086 # Only ROUND_ROBIN and RING_HASH are supported
5087 # when the backend service is referenced by a URL map that is bound to
5088 # target gRPC proxy that has validateForProxyless field set to true.
5089 #
5090 # localityLbPolicy cannot be specified with haPolicy.
5091 &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
5092 # by this backend service. If logging is enabled, logs will be exported to
5093 # Stackdriver.
5094 # backend service.
5095 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
5096 # traffic served by this backend service. The default value is false.
5097 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
5098 { # Determines which HTTP headers will be logged to Stackdriver.
5099 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
5100 },
5101 ],
5102 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
5103 { # Determines which HTTP headers will be logged to Stackdriver.
5104 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
5105 },
5106 ],
5107 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
5108 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
5109 # of optional fields you want to include in the logs. For example:
5110 # serverInstance, serverGkeDetails.cluster,
5111 # serverGkeDetails.pod.podNamespace
5112 &quot;A String&quot;,
5113 ],
5114 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
5115 # service. Configures whether all, none or a subset of optional fields
5116 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
5117 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
5118 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
5119 # service. The value of the field must be in [0, 1]. This configures the
5120 # sampling rate of requests to the load balancer where 1.0 means all logged
5121 # requests are reported and 0.0 means no logged requests are reported. The
5122 # default value is 1.0.
5123 },
5124 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
5125 # service. Duration is computed from the beginning of the stream until the
5126 # response has been completely processed, including all retries. A stream
5127 # that does not complete in this duration is closed.
5128 #
5129 # If not specified, there will be no timeout limit, i.e. the maximum
5130 # duration is infinite.
5131 #
5132 # This value can be overridden in the PathMatcher configuration of the
5133 # UrlMap that references this backend service.
5134 #
5135 # This field is only allowed when the loadBalancingScheme of
5136 # the backend service is INTERNAL_SELF_MANAGED.
5137 # as a count of seconds and fractions of seconds at nanosecond
5138 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
5139 # or &quot;month&quot;. Range is approximately 10,000 years.
5140 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
5141 # Durations less than one second are represented with a 0
5142 # `seconds` field and a positive `nanos` field. Must be from 0
5143 # to 999,999,999 inclusive.
5144 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
5145 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
5146 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
5147 },
5148 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
5149 # controller and read by the backend RCTH
5150 &quot;a_key&quot;: &quot;A String&quot;,
5151 },
5152 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
5153 # The name must be 1-63 characters long, and comply withRFC1035.
5154 # Specifically, the name must be 1-63 characters long and match the regular
5155 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
5156 # character must be a lowercase letter, and all following characters must
5157 # be a dash, lowercase letter, or digit, except the last character, which
5158 # cannot be a dash.
5159 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
5160 #
5161 # This field must be set for Internal Passthrough Network Load Balancers when
5162 # the haPolicy is enabled, and for External Passthrough Network Load
5163 # Balancers when the haPolicy fastIpMove is enabled.
5164 #
5165 # 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.
5166 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
5167 # Load Balancers.
5168 #
5169 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
5170 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
5171 # endpoints in the local zone.
5172 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
5173 # possible values are:
5174 #
5175 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
5176 # is disabled. The load balancer distributes new connections to all
5177 # healthy backend endpoints across all zones.
5178 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
5179 # enabled. The load balancer distributes new connections to all healthy
5180 # backend endpoints in the local zone only. If there are no healthy
5181 # backend endpoints in the local zone, the load balancer distributes
5182 # new connections to all backend endpoints in the local zone.
5183 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
5184 # enabled. The load balancer distributes new connections to all healthy
5185 # backend endpoints in the local zone only. If there aren&#x27;t enough
5186 # healthy backend endpoints in the local zone, the load balancer
5187 # distributes new connections to all healthy backend endpoints across all
5188 # zones.
5189 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
5190 # of healthy backend endpoints in a zone to the count of backend
5191 # endpoints in that same zone is equal to or above this threshold, the
5192 # load balancer distributes new connections to all healthy endpoints in
5193 # the local zone only. When the ratio of the count of healthy backend
5194 # endpoints in a zone to the count of backend endpoints in that same
5195 # zone is below this threshold, the load balancer distributes all new
5196 # connections to all healthy endpoints across all zones.
5197 },
5198 },
5199 &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.
5200 # the backend service.
5201 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
5202 # service.
5203 },
5204 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
5205 # load balancing pool of each individual proxy instance that processes the
5206 # traffic for the given backend service. If not set, this feature is
5207 # considered disabled.
5208 #
5209 # Results of the outlier detection algorithm (ejection of endpoints from the
5210 # load balancing pool and returning them back to the pool) are executed
5211 # independently by each proxy instance of the load balancer. In most cases,
5212 # more than one proxy instance handles the traffic received by a backend
5213 # service. Thus, it is possible that an unhealthy endpoint is detected and
5214 # ejected by only some of the proxies, and while this happens, other proxies
5215 # may continue to send requests to the same unhealthy endpoint until they
5216 # detect and eject the unhealthy endpoint.
5217 #
5218 # Applicable backend endpoints can be:
5219 #
5220 # - VM instances in an Instance Group
5221 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
5222 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
5223 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
5224 # Functions Services
5225 # - Private Service Connect NEGs, that resolve to
5226 # Google-managed regional API endpoints or managed services published using
5227 # Private Service Connect
5228 #
5229 #
5230 #
5231 # Applicable backend service types can be:
5232 #
5233 # - A global backend service with the loadBalancingScheme set to
5234 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
5235 # - A regional backend
5236 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
5237 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
5238 # supported for Serverless NEGs.
5239 #
5240 #
5241 #
5242 # Not supported when the backend service is referenced by a URL map that is
5243 # bound to target gRPC proxy that has validateForProxyless field set to true.
5244 # pool for the backend service.
5245 &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
5246 # or 30s.
5247 #
5248 # After a backend endpoint is returned back to the load balancing pool, it
5249 # can be ejected again in another ejection analysis. Thus, the total ejection
5250 # time is equal to the base ejection time multiplied by the number of times
5251 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
5252 # as a count of seconds and fractions of seconds at nanosecond
5253 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
5254 # or &quot;month&quot;. Range is approximately 10,000 years.
5255 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
5256 # Durations less than one second are represented with a 0
5257 # `seconds` field and a positive `nanos` field. Must be from 0
5258 # to 999,999,999 inclusive.
5259 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
5260 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
5261 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
5262 },
5263 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
5264 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
5265 # return code qualifies as an error. Defaults to 5.
5266 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
5267 # connection errors that are mapped to one of those status codes) before a
5268 # consecutive gateway failure ejection occurs. Defaults to 3.
5269 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
5270 # outlier status is detected through consecutive 5xx. This setting can be
5271 # used to disable ejection or to ramp it up slowly. Defaults to 0.
5272 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
5273 # outlier status is detected through consecutive gateway failures. This
5274 # setting can be used to disable ejection or to ramp it up slowly. Defaults
5275 # to 100.
5276 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
5277 # outlier status is detected through success rate statistics. This setting
5278 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
5279 #
5280 # Not supported when the backend service uses Serverless NEG.
5281 &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
5282 # ejections and backend endpoints being returned to service. The interval is
5283 # equal to the number of seconds as defined in
5284 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
5285 # in outlierDetection.interval.nanos. Defaults to 1 second.
5286 # as a count of seconds and fractions of seconds at nanosecond
5287 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
5288 # or &quot;month&quot;. Range is approximately 10,000 years.
5289 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
5290 # Durations less than one second are represented with a 0
5291 # `seconds` field and a positive `nanos` field. Must be from 0
5292 # to 999,999,999 inclusive.
5293 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
5294 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
5295 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
5296 },
5297 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
5298 # backend service that can be ejected if the ejection conditions are met.
5299 # Defaults to 50%.
5300 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
5301 # enough request volume to detect success rate outliers. If the number of
5302 # backend endpoints is fewer than this setting, outlier detection via success
5303 # rate statistics is not performed for any backend endpoint in the load
5304 # balancing pool. Defaults to 5.
5305 #
5306 # Not supported when the backend service uses Serverless NEG.
5307 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
5308 # (as defined by the interval duration above) to include this backend
5309 # endpoint in success rate based outlier detection. If the volume is lower
5310 # than this setting, outlier detection via success rate statistics is not
5311 # performed for that backend endpoint. Defaults to 100.
5312 #
5313 # Not supported when the backend service uses Serverless NEG.
5314 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
5315 # outlier ejection. The ejection threshold is the difference between the mean
5316 # success rate, and the product of this factor and the standard deviation of
5317 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
5318 # is divided by a thousand to get a double. That is, if the desired factor
5319 # is 1.9, the runtime value should be 1900. Defaults to 1900.
5320 #
5321 # Not supported when the backend service uses Serverless NEG.
5322 },
5323 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
5324 # as part of resource payload.
5325 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
5326 # Tag keys and values have the same definition as resource
5327 # manager tags. The field is allowed for INSERT
5328 # only. The keys/values to set on the resource should be specified in
5329 # either ID { : } or Namespaced format
5330 # { : }.
5331 # For example the following are valid inputs:
5332 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
5333 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
5334 # Note:
5335 # * Invalid combinations of ID &amp; namespaced format is not supported. For
5336 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
5337 &quot;a_key&quot;: &quot;A String&quot;,
5338 },
5339 },
5340 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
5341 # the backend. The default value is 80.
5342 # For internal passthrough Network Load Balancers and external passthrough
5343 # Network Load Balancers, omit port.
5344 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
5345 # communication to the backend VMs in that group. The
5346 # named port must be [defined on each backend instance
5347 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
5348 # This parameter has no meaning if the backends are NEGs. For internal
5349 # passthrough Network Load Balancers and external passthrough Network Load
5350 # Balancers, omit port_name.
5351 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
5352 # with backends.
5353 #
5354 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
5355 # depending on the chosen load balancer or Traffic Director configuration.
5356 # Refer to the documentation for the load balancers or for Traffic Director
5357 # for more information.
5358 #
5359 # Must be set to GRPC when the backend service is referenced by a URL map
5360 # that is bound to target gRPC proxy.
5361 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
5362 # resides. This field is not applicable to global backend services.
5363 # You must specify this field as part of the HTTP request URL. It is
5364 # not settable as a field in the request body.
5365 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
5366 # backend service.
5367 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
5368 # service. This field is applicable to a global backend service with the
5369 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
5370 &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
5371 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
5372 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
5373 # private storage buckets that support Signature Version 4 for authentication.
5374 # The service name for generating the authentication header will always default
5375 # to &#x27;s3&#x27;.
5376 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
5377 # creating a backend that uses AWS v4 signature authentication, but will not
5378 # be returned as part of the configuration when queried with a REST API GET
5379 # request.
5380 #
5381 # @InputOnly
5382 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
5383 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
5384 # keep track of different iterations of your access key.
5385 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
5386 # the name of the region your cloud uses to host your origin. For example,
5387 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
5388 },
5389 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
5390 # that describes how clients should authenticate with this service&#x27;s
5391 # backends.
5392 #
5393 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
5394 # to INTERNAL_SELF_MANAGED.
5395 #
5396 # If left blank, communications are not encrypted.
5397 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
5398 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
5399 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
5400 # specified values, the communication continues. Otherwise, it fails. This
5401 # additional check enables the client to verify that the server is authorized
5402 # to run the requested service.
5403 #
5404 # Note that the contents of the server
5405 # certificate&#x27;s subjectAltName field are configured by the
5406 # Public Key Infrastructure which provisions server identities.
5407 #
5408 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
5409 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
5410 # mode).
5411 &quot;A String&quot;,
5412 ],
5413 },
5414 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5415 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
5416 #
5417 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
5418 # If set, lists of backends and health checks must be both empty.
5419 &quot;A String&quot;,
5420 ],
5421 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
5422 #
5423 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
5424 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
5425 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
5426 #
5427 # Only NONE and HEADER_FIELD are supported
5428 # when the backend service is referenced by a URL map that is bound to
5429 # target gRPC proxy that has validateForProxyless field set to true.
5430 #
5431 # For more details, see:
5432 # [Session
5433 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
5434 #
5435 # sessionAffinity cannot be specified with haPolicy.
5436 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
5437 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
5438 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
5439 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
5440 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
5441 # as a count of seconds and fractions of seconds at nanosecond
5442 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
5443 # or &quot;month&quot;. Range is approximately 10,000 years.
5444 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
5445 # Durations less than one second are represented with a 0
5446 # `seconds` field and a positive `nanos` field. Must be from 0
5447 # to 999,999,999 inclusive.
5448 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
5449 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
5450 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
5451 },
5452 },
5453 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
5454 # Currently this is applicable only for Internal TCP/UDP load balancing,
5455 # Internal HTTP(S) load balancing and Traffic Director.
5456 &quot;policy&quot;: &quot;A String&quot;,
5457 },
5458 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
5459 # type of load balancer. For more information see,
5460 # Backend service settings.
5461 # The default is 30 seconds.
5462 # The full range of timeout values allowed goes from 1
5463 # through 2,147,483,647 seconds.
5464 #
5465 # This value can be overridden in the PathMatcher configuration of the
5466 # UrlMap that references this backend service.
5467 #
5468 # Not supported when the backend service is referenced by a URL map that is
5469 # bound to target gRPC proxy that has validateForProxyless field set to true.
5470 # Instead, use maxStreamDuration.
5471 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
5472 # when the backend protocol is SSL, HTTPS or HTTP2.
5473 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
5474 # networksecurity.googleapis.com namespace. Can be used in authenticating
5475 # TLS connections to the backend, as specified by the authenticationMode
5476 # field. Can only be specified if authenticationMode is not NONE.
5477 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
5478 # balancer sends this string as the SNI hostname in the TLS connection to
5479 # the backend, and requires that this string match a Subject Alternative
5480 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
5481 # NEG backend, if the SNI is specified here, the load balancer uses it
5482 # regardless of whether the Regional Internet NEG is specified with FQDN or
5483 # IP address and port. When both sni and subjectAltNames[] are specified,
5484 # the load balancer matches the backend certificate&#x27;s SAN only to
5485 # subjectAltNames[].
5486 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
5487 # verifies during a TLS handshake with the backend. When the server
5488 # presents its X.509 certificate to the Load Balancer, the Load Balancer
5489 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
5490 # match one of the subjectAltNames in the list. This field is limited to 5
5491 # entries. When both sni and subjectAltNames[] are specified, the load
5492 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
5493 { # A Subject Alternative Name that the load balancer matches against the SAN
5494 # field in the TLS certificate provided by the backend, specified as either
5495 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
5496 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
5497 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
5498 },
5499 ],
5500 },
5501 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
5502 {
5503 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
5504 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
5505 # and ForwardingRule.
5506 },
5507 ],
5508 }
5509
5510 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
5511 that if you must retry your request, the server will know to ignore the
5512 request if it has already been completed.
5513
5514 For example, consider a situation where you make an initial request and
5515 the request times out. If you make the request again with the same
5516 request ID, the server can check if original operation with the same
5517 request ID was received, and if so, will ignore the second request. This
5518 prevents clients from accidentally creating duplicate commitments.
5519
5520 The request ID must be
5521 a valid UUID with the exception that zero UUID is not supported
5522 (00000000-0000-0000-0000-000000000000).
5523 x__xgafv: string, V1 error format.
5524 Allowed values
5525 1 - v1 error format
5526 2 - v2 error format
5527
5528 Returns:
5529 An object of the form:
5530
5531 { # Represents an Operation resource.
5532 #
5533 # Google Compute Engine has three Operation resources:
5534 #
5535 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
5536 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
5537 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
5538 #
5539 # You can use an operation resource to manage asynchronous API requests.
5540 # For more information, readHandling
5541 # API responses.
5542 #
5543 # Operations can be global, regional or zonal.
5544 #
5545 # - For global operations, use the `globalOperations`
5546 # resource.
5547 # - For regional operations, use the
5548 # `regionOperations` resource.
5549 # - For zonal operations, use
5550 # the `zoneOperations` resource.
5551 #
5552 #
5553 #
5554 # For more information, read
5555 # Global, Regional, and Zonal Resources.
5556 #
5557 # Note that completed Operation resources have a limited
5558 # retention period.
5559 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
5560 # Not present otherwise.
5561 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5562 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
5563 # set when the operation is created.
5564 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
5565 # text format.
5566 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
5567 # this field will be populated.
5568 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
5569 # operation.
5570 {
5571 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5572 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
5573 # details. There is a set of defined message types to use for providing
5574 # details.The syntax depends on the error code. For example,
5575 # QuotaExceededInfo will have details when the error code is
5576 # QUOTA_EXCEEDED.
5577 {
5578 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
5579 #
5580 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
5581 # is not enabled:
5582 #
5583 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
5584 # &quot;domain&quot;: &quot;googleapis.com&quot;
5585 # &quot;metadata&quot;: {
5586 # &quot;resource&quot;: &quot;projects/123&quot;,
5587 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
5588 # }
5589 # }
5590 #
5591 # This response indicates that the pubsub.googleapis.com API is not enabled.
5592 #
5593 # Example of an error that is returned when attempting to create a Spanner
5594 # instance in a region that is out of stock:
5595 #
5596 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
5597 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
5598 # &quot;metadata&quot;: {
5599 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
5600 # }
5601 # }
5602 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
5603 # is typically the registered service name of the tool or product that
5604 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
5605 # generated by some common infrastructure, the error domain must be a
5606 # globally unique value that identifies the infrastructure. For Google API
5607 # infrastructure, the error domain is &quot;googleapis.com&quot;.
5608 &quot;metadatas&quot;: { # Additional structured details about this error.
5609 #
5610 # Keys must match a regular expression of `a-z+` but should
5611 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
5612 # length. When identifying the current value of an exceeded limit, the units
5613 # should be contained in the key, not the value. For example, rather than
5614 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
5615 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
5616 # instances that can be created in a single (batch) request.
5617 &quot;a_key&quot;: &quot;A String&quot;,
5618 },
5619 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
5620 # proximate cause of the error. Error reasons are unique within a particular
5621 # domain of errors. This should be at most 63 characters and match a
5622 # regular expression of `A-Z+[A-Z0-9]`, which represents
5623 # UPPER_SNAKE_CASE.
5624 },
5625 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
5626 #
5627 # For example, if a quota check failed with an error indicating the calling
5628 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
5629 # directly to the right place in the developer console to flip the bit.
5630 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
5631 { # Describes a URL link.
5632 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
5633 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
5634 },
5635 ],
5636 },
5637 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
5638 # which can be attached to an RPC error.
5639 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
5640 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
5641 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
5642 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
5643 },
5644 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
5645 &quot;dimensions&quot;: { # The map holding related quota dimensions.
5646 &quot;a_key&quot;: &quot;A String&quot;,
5647 },
5648 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
5649 # type or metric.
5650 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
5651 # or metric.
5652 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
5653 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
5654 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
5655 },
5656 },
5657 ],
5658 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
5659 # This property is optional.
5660 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
5661 },
5662 ],
5663 },
5664 &quot;getVersionOperationMetadata&quot;: {
5665 &quot;inlineSbomInfo&quot;: {
5666 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
5667 # appropriate identifiers.
5668 &quot;a_key&quot;: &quot;A String&quot;,
5669 },
5670 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
5671 # identifiers.
5672 &quot;a_key&quot;: &quot;A String&quot;,
5673 },
5674 },
5675 },
5676 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
5677 # message that was returned, such as `NOT FOUND`.
5678 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
5679 # status code that was returned. For example, a `404` means the
5680 # resource was not found.
5681 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
5682 # defined by the server.
5683 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
5684 # This value is inRFC3339
5685 # text format.
5686 &quot;instancesBulkInsertOperationMetadata&quot;: {
5687 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
5688 # Example key: zones/us-central1-a
5689 &quot;a_key&quot;: {
5690 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
5691 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
5692 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
5693 # error.
5694 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
5695 # if the flow is rolling forward or rolling back.
5696 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
5697 },
5698 },
5699 },
5700 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
5701 # Operation resources.
5702 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
5703 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
5704 # group of operations results from a `bulkInsert` API request.
5705 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
5706 # `update`, or `delete`, and so on.
5707 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
5708 # There is no requirement that this be linear or support any granularity of
5709 # operations. This should not be used to guess when the operation will be
5710 # complete. This number should monotonically increase as the operation
5711 # progresses.
5712 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
5713 # applicable when performing regional operations.
5714 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5715 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
5716 # this field will contain information on all underlying zonal actions and
5717 # their state.
5718 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
5719 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
5720 # Example key: zones/us-central1-a
5721 &quot;a_key&quot;: {
5722 &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
5723 # populated.
5724 # different programming environments, including REST APIs and RPC APIs. It is
5725 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
5726 # three pieces of data: error code, error message, and error details.
5727 #
5728 # You can find out more about this error model and how to work with it in the
5729 # [API Design Guide](https://cloud.google.com/apis/design/errors).
5730 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
5731 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
5732 # message types for APIs to use.
5733 {
5734 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
5735 },
5736 ],
5737 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
5738 # user-facing error message should be localized and sent in the
5739 # google.rpc.Status.details field, or localized by the client.
5740 },
5741 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
5742 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
5743 },
5744 },
5745 },
5746 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
5747 # This value is inRFC3339
5748 # text format.
5749 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
5750 # following:
5751 # `PENDING`, `RUNNING`, or `DONE`.
5752 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
5753 # operation.
5754 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
5755 # of the target resource.
5756 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
5757 # operations related to creating a snapshot, this points to the disk
5758 # that the snapshot was created from.
5759 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
5760 # `[email protected]` or
5761 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
5762 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
5763 # operation, this field will be populated.
5764 {
5765 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5766 # Engine returns NO_RESULTS_ON_PAGE if there
5767 # are no results in the response.
5768 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5769 # value format. For example:
5770 #
5771 # &quot;data&quot;: [
5772 # {
5773 # &quot;key&quot;: &quot;scope&quot;,
5774 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5775 # }
5776 {
5777 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5778 # returned. For example, for warnings where there are no results in a list
5779 # request for a particular zone, this key might be scope and
5780 # the key value might be the zone name. Other examples might be a key
5781 # indicating a deprecated resource and a suggested replacement, or a
5782 # warning about invalid network settings (for example, if an instance
5783 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5784 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5785 },
5786 ],
5787 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5788 },
5789 ],
5790 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
5791 # applicable when performing per-zone operations.
5792 }</pre>
5793 </div>
5794
5795 <div class="method">
5796 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
5797 <pre>Retrieves the list of BackendService resources available to the specified
5798 project.
5799
5800 Args:
5801 project: string, Project ID for this request. (required)
5802 filter: string, A filter expression that filters resources listed in the response. Most
5803 Compute resources support two types of filter expressions:
5804 expressions that support regular expressions and expressions that follow
5805 API improvement proposal AIP-160.
5806 These two types of filter expressions cannot be mixed in one request.
5807
5808 If you want to use AIP-160, your expression must specify the field name, an
5809 operator, and the value that you want to use for filtering. The value
5810 must be a string, a number, or a boolean. The operator
5811 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
5812
5813 For example, if you are filtering Compute Engine instances, you can
5814 exclude instances named `example-instance` by specifying
5815 `name != example-instance`.
5816
5817 The `:*` comparison can be used to test whether a key has been defined.
5818 For example, to find all objects with `owner` label use:
5819 ```
5820 labels.owner:*
5821 ```
5822
5823 You can also filter nested fields. For example, you could specify
5824 `scheduling.automaticRestart = false` to include instances only
5825 if they are not scheduled for automatic restarts. You can use filtering
5826 on nested fields to filter based onresource labels.
5827
5828 To filter on multiple expressions, provide each separate expression within
5829 parentheses. For example:
5830 ```
5831 (scheduling.automaticRestart = true)
5832 (cpuPlatform = &quot;Intel Skylake&quot;)
5833 ```
5834 By default, each expression is an `AND` expression. However, you
5835 can include `AND` and `OR` expressions explicitly.
5836 For example:
5837 ```
5838 (cpuPlatform = &quot;Intel Skylake&quot;) OR
5839 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
5840 (scheduling.automaticRestart = true)
5841 ```
5842
5843 If you want to use a regular expression, use the `eq` (equal) or `ne`
5844 (not equal) operator against a single un-parenthesized expression with or
5845 without quotes or against multiple parenthesized expressions. Examples:
5846
5847 `fieldname eq unquoted literal`
5848 `fieldname eq &#x27;single quoted literal&#x27;`
5849 `fieldname eq &quot;double quoted literal&quot;`
5850 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
5851
5852 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
5853 The literal value must match the entire field.
5854
5855 For example, to filter for instances that do not end with name &quot;instance&quot;,
5856 you would use `name ne .*instance`.
5857
5858 You cannot combine constraints on multiple fields using regular
5859 expressions.
5860 maxResults: integer, The maximum number of results per page that should be returned.
5861 If the number of available results is larger than `maxResults`,
5862 Compute Engine returns a `nextPageToken` that can be used to get
5863 the next page of results in subsequent list requests. Acceptable values are
5864 `0` to `500`, inclusive. (Default: `500`)
5865 orderBy: string, Sorts list results by a certain order. By default, results
5866 are returned in alphanumerical order based on the resource name.
5867
5868 You can also sort results in descending order based on the creation
5869 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
5870 results based on the `creationTimestamp` field in
5871 reverse chronological order (newest result first). Use this to sort
5872 resources like operations so that the newest operation is returned first.
5873
5874 Currently, only sorting by `name` or
5875 `creationTimestamp desc` is supported.
5876 pageToken: string, Specifies a page token to use. Set `pageToken` to the
5877 `nextPageToken` returned by a previous list request to get
5878 the next page of results.
5879 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
5880 of failure. The default value is false.
5881
5882 For example, when partial success behavior is enabled, aggregatedList for a
5883 single zone scope either returns all resources in the zone or no resources,
5884 with an error code.
5885 x__xgafv: string, V1 error format.
5886 Allowed values
5887 1 - v1 error format
5888 2 - v2 error format
5889
5890 Returns:
5891 An object of the form:
5892
5893 { # Contains a list of BackendService resources.
5894 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
5895 &quot;items&quot;: [ # A list of BackendService resources.
5896 { # Represents a Backend Service resource.
5897 #
5898 # A backend service defines how Google Cloud load balancers distribute traffic.
5899 # The backend service configuration contains a set of values, such as the
5900 # protocol used to connect to backends, various distribution and session
5901 # settings, health checks, and timeouts. These settings provide fine-grained
5902 # control over how your load balancer behaves. Most of the settings have
5903 # default values that allow for easy configuration if you need to get started
5904 # quickly.
5905 #
5906 # Backend services in Google Compute Engine can be either regionally or
5907 # globally scoped.
5908 #
5909 # * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices)
5910 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices)
5911 #
5912 # For more information, seeBackend
5913 # Services.
5914 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
5915 # Load Balancers and Traffic Director and requires
5916 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
5917 #
5918 # If set to 0, the cookie is non-persistent and lasts only until
5919 # the end of the browser session (or equivalent). The maximum allowed value
5920 # is two weeks (1,209,600).
5921 #
5922 # Not supported when the backend service is referenced by a URL map that is
5923 # bound to target gRPC proxy that has validateForProxyless field set to true.
5924 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
5925 { # Message containing information of one individual backend.
5926 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
5927 # handle additional traffic or is fully loaded. For usage guidelines, see
5928 # Connection balancing mode.
5929 #
5930 # Backends must use compatible balancing modes. For more information, see
5931 # Supported balancing modes and target capacity settings and
5932 # Restrictions and guidance for instance groups.
5933 #
5934 # Note: Currently, if you use the API to configure incompatible balancing
5935 # modes, the configuration might be accepted even though it has no impact
5936 # and is ignored. Specifically, Backend.maxUtilization is ignored when
5937 # Backend.balancingMode is RATE. In the future, this incompatible combination
5938 # will be rejected.
5939 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
5940 # mode.
5941 # The default value is 1, which means the group serves up to
5942 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
5943 # completely drained, offering 0% of its available capacity. The valid ranges
5944 # are 0.0 and [0.1,1.0].
5945 # You cannot configure a setting larger than 0 and smaller than0.1.
5946 # You cannot configure a setting of 0 when there is only one
5947 # backend attached to the backend service.
5948 #
5949 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
5950 # internet NEGs, regional serverless NEGs, and PSC NEGs.
5951 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
5952 # BalancingMode.
5953 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
5954 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
5955 # Monitoring, but is not used for load balancing.
5956 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
5957 # balancing mode. The valid range is [0.0, 1.0].
5958 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
5959 # long and match the regular expression
5960 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
5961 # first character must be a lowercase letter, and all following
5962 # characters must be a dash, period, underscore, lowercase letter, or
5963 # digit, except the last character, which cannot be a dash, period, or
5964 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
5965 # field can only be used for a global or regional backend service with the
5966 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
5967 },
5968 ],
5969 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
5970 # create the resource.
5971 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
5972 # failover backend can be configured for a given BackendService.
5973 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
5974 # group or network endpoint
5975 # group (NEG) resource. To determine what types of backends a load
5976 # balancer supports, see the [Backend services
5977 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
5978 #
5979 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
5980 # or NEG. Partial URLs are not supported.
5981 #
5982 # If haPolicy is specified, backends must refer to NEG resources of type
5983 # GCE_VM_IP.
5984 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
5985 # guidelines, seeConnection
5986 # balancing mode and Utilization
5987 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
5988 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
5989 # guidelines, seeConnection
5990 # balancing mode and Utilization
5991 # balancing mode.
5992 #
5993 # Not available if the backend&#x27;s balancingMode isRATE.
5994 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
5995 # For usage guidelines, seeConnection
5996 # balancing mode and Utilization
5997 # balancing mode.
5998 #
5999 # Not available if the backend&#x27;s balancingMode isRATE.
6000 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
6001 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
6002 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
6003 # Not available if backend&#x27;s balancingMode is RATE
6004 # or CONNECTION.
6005 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
6006 # Not available if backend&#x27;s balancingMode is RATE
6007 # or CONNECTION.
6008 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
6009 # usage guidelines, seeRate
6010 # balancing mode and Utilization
6011 # balancing mode.
6012 #
6013 # Not available if the backend&#x27;s balancingMode isCONNECTION.
6014 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
6015 # guidelines, seeRate
6016 # balancing mode and Utilization
6017 # balancing mode.
6018 #
6019 # Not available if the backend&#x27;s balancingMode isCONNECTION.
6020 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
6021 # guidelines, seeRate
6022 # balancing mode and Utilization
6023 # balancing mode.
6024 #
6025 # Not available if the backend&#x27;s balancingMode isCONNECTION.
6026 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
6027 #
6028 # For usage guidelines, seeUtilization
6029 # balancing mode.
6030 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
6031 # the backend.
6032 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
6033 },
6034 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
6035 # sending traffic to backends with default preference. The possible values
6036 # are:
6037 #
6038 # - PREFERRED: Backends with this preference level will be
6039 # filled up to their capacity limits first, based on RTT.
6040 # - DEFAULT: If preferred backends don&#x27;t have enough
6041 # capacity, backends in this layer would be used and traffic would be
6042 # assigned based on the load balancing algorithm you use. This is the
6043 # default
6044 &quot;trafficDuration&quot;: &quot;A String&quot;,
6045 },
6046 ],
6047 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
6048 # specified load balancer types.
6049 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
6050 # Pragma or Authorization headers. Up to 5 headers can be specified.
6051 # The cache is bypassed for all cdnPolicy.cacheMode settings.
6052 { # Bypass the cache when the specified request headers are present,
6053 # e.g. Pragma or Authorization headers. Values are case insensitive.
6054 # The presence of such a header overrides the cache_mode setting.
6055 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
6056 # Values are case-insensitive.
6057 },
6058 ],
6059 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
6060 # CDN.
6061 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
6062 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
6063 &quot;A String&quot;,
6064 ],
6065 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
6066 # The name=value pair will be used in the cache key Cloud CDN generates.
6067 &quot;A String&quot;,
6068 ],
6069 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
6070 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
6071 # query_string_whitelist and query_string_blacklist. If neither is set, the
6072 # entire query string will be included. If false, the query string will be
6073 # excluded from the cache key entirely.
6074 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
6075 # parameters will be included. Either specify query_string_whitelist or
6076 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
6077 # not treated as delimiters.
6078 &quot;A String&quot;,
6079 ],
6080 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
6081 # parameters will be excluded. Either specify query_string_whitelist or
6082 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
6083 # not treated as delimiters.
6084 &quot;A String&quot;,
6085 ],
6086 },
6087 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
6088 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
6089 # headers to cache content. Responses without these headers will not be
6090 # cached at Google&#x27;s edge, and will require a full trip to the origin on
6091 # every request, potentially impacting performance and increasing load on
6092 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
6093 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
6094 # Warning: this may result in Cloud CDN caching private,
6095 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
6096 # including common image formats, media (video and audio), and web assets
6097 # (JavaScript and CSS). Requests and responses that are marked as
6098 # uncacheable, as well as dynamic content (including HTML), will not be
6099 # cached.
6100 #
6101 # If no value is provided for cdnPolicy.cacheMode, it defaults
6102 # to CACHE_ALL_STATIC.
6103 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
6104 # used to clamp the max-age (or Expires) value sent to the client. With
6105 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
6106 # response max-age directive, along with a &quot;public&quot; directive. For
6107 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
6108 # from the origin (if specified), or else sets the response max-age
6109 # directive to the lesser of the client_ttl and default_ttl, and also
6110 # ensures a &quot;public&quot; cache-control directive is present.
6111 # If a client TTL is not specified, a default value (1 hour) will be used.
6112 # The maximum allowed value is 31,622,400s (1 year).
6113 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
6114 # responses that do not have an existing valid TTL (max-age or s-maxage).
6115 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
6116 # The value of defaultTTL cannot be set to a value greater than that of
6117 # maxTTL, but can be equal.
6118 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
6119 # will overwrite the TTL set in all responses. The maximum allowed value is
6120 # 31,622,400s (1 year), noting that infrequently accessed objects may be
6121 # evicted from the cache before the defined TTL.
6122 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
6123 # origin.
6124 # Cache directives that attempt to set a max-age or s-maxage higher than
6125 # this, or an Expires header more than maxTTL seconds in the future will
6126 # be capped at the value of maxTTL, as if it were the value of an
6127 # s-maxage Cache-Control directive.
6128 # Headers sent to the client will not be modified.
6129 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
6130 # The maximum allowed value is 31,622,400s (1 year), noting that
6131 # infrequently accessed objects may be evicted from the cache before
6132 # the defined TTL.
6133 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
6134 # to apply fine-grained caching for common errors or redirects.
6135 # This can reduce the load on your origin and improve end-user
6136 # experience by reducing response latency.
6137 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
6138 # negative caching applies to responses with the specified response code
6139 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
6140 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
6141 # to all responses with the specified response code, and override any
6142 # caching headers.
6143 # By default, Cloud CDN will apply the following default TTLs to these
6144 # status codes:
6145 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
6146 # HTTP 404 (Not Found), 410 (Gone),
6147 # 451 (Unavailable For Legal Reasons): 120s
6148 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
6149 # These defaults can be overridden in negative_caching_policy.
6150 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
6151 # negative_caching must be enabled to configure negative_caching_policy.
6152 # Omitting the policy and leaving negative_caching enabled will use
6153 # Cloud CDN&#x27;s default cache TTLs.
6154 # Note that when specifying an explicit negative_caching_policy, you
6155 # should take care to specify a cache TTL for all response codes
6156 # that you wish to cache. Cloud CDN will not apply any default
6157 # negative caching when a policy exists.
6158 { # Specify CDN TTLs for response error codes.
6159 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
6160 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
6161 # specified as values, and you cannot specify a status code more than
6162 # once.
6163 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
6164 # corresponding status code.
6165 # The maximum allowed value is 1800s (30 minutes), noting that
6166 # infrequently accessed objects may be evicted from the cache before the
6167 # defined TTL.
6168 },
6169 ],
6170 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
6171 # requests into a small number of requests to the origin.
6172 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
6173 # content with the origin, or when an error is encountered when refreshing
6174 # the cache.
6175 # This setting defines the default &quot;max-stale&quot; duration for any cached
6176 # responses that do not specify a max-stale directive. Stale responses that
6177 # exceed the TTL configured here will not be served. The default limit
6178 # (max-stale) is 86400s (1 day), which will allow stale content to be
6179 # served up to this limit beyond the max-age (or s-maxage) of a cached
6180 # response.
6181 # The maximum allowed value is 604800 (1 week).
6182 # Set this to zero (0) to disable serve-while-stale.
6183 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
6184 # considered fresh. After this time period, the response will be
6185 # revalidated before being served. Defaults to 1hr (3600s). When serving
6186 # responses to signed URL requests, Cloud CDN will internally behave as
6187 # though all responses from this backend had a &quot;Cache-Control:
6188 # public, max-age=[TTL]&quot; header, regardless of any existing
6189 # Cache-Control header. The actual headers served in responses will not be
6190 # altered.
6191 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
6192 &quot;A String&quot;,
6193 ],
6194 },
6195 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
6196 # backend service.
6197 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
6198 # there is no limit.
6199 #
6200 # Not supported when the backend service is referenced by a URL map that is
6201 # bound to target gRPC proxy that has validateForProxyless field set to true.
6202 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
6203 # not specified, there is no limit.
6204 #
6205 # Not supported when the backend service is referenced by a URL map that is
6206 # bound to target gRPC proxy that has validateForProxyless field set to true.
6207 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
6208 # service. If not specified, there is no limit.
6209 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
6210 # This parameter is respected by both the HTTP/1.1 and HTTP/2
6211 # implementations. If not specified, there is no limit. Setting this
6212 # parameter to 1 will effectively disable keep alive.
6213 #
6214 # Not supported when the backend service is referenced by a URL map that is
6215 # bound to target gRPC proxy that has validateForProxyless field set to true.
6216 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
6217 # not specified, the default is 1.
6218 #
6219 # Not supported when the backend service is referenced by a URL map that is
6220 # bound to target gRPC proxy that has validateForProxyless field set to true.
6221 },
6222 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
6223 # the client&#x27;s Accept-Encoding header.
6224 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
6225 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
6226 # instance. For supported load balancers and protocols, as described inEnabling
6227 # connection draining.
6228 },
6229 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
6230 # tracking policy settings are only available for external passthrough
6231 # Network Load Balancers and internal passthrough Network Load Balancers.
6232 #
6233 # connectionTrackingPolicy cannot be specified with haPolicy.
6234 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
6235 # value is DEFAULT_FOR_PROTOCOL.
6236 #
6237 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
6238 # persist on unhealthy backends only for connection-oriented protocols
6239 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
6240 # Affinity is configured for 5-tuple. They do not persist forUDP.
6241 #
6242 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
6243 # the existing connections on the unhealthy backend are never persisted on
6244 # the unhealthy backend. They are always diverted to newly selected healthy
6245 # backends (unless all backends are unhealthy).
6246 #
6247 # If set to ALWAYS_PERSIST, existing connections always
6248 # persist on unhealthy backends regardless of protocol and session
6249 # affinity. It is generally not recommended to use this mode overriding the
6250 # default.
6251 #
6252 # For more details, see [Connection Persistence for Network Load
6253 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
6254 # and [Connection Persistence for Internal TCP/UDP Load
6255 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
6256 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
6257 # Balancers. This option is not available publicly.
6258 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
6259 # matching traffic (in seconds).
6260 #
6261 # For internal passthrough Network Load Balancers:
6262 #
6263 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
6264 # - It can be set only if Connection Tracking is less than 5-tuple
6265 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
6266 # Mode is PER_SESSION).
6267 #
6268 #
6269 #
6270 # For external passthrough Network Load Balancers the default is 60
6271 # seconds. This option is not available publicly.
6272 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
6273 # options:
6274 #
6275 # - PER_CONNECTION: This is the default mode. The Connection
6276 # Tracking is performed as per the Connection Key (default Hash Method) for
6277 # the specific protocol.
6278 # - PER_SESSION: The Connection Tracking is performed as per
6279 # the configured Session Affinity. It matches the configured Session
6280 # Affinity.
6281 #
6282 #
6283 #
6284 # For more details, see [Tracking Mode for Network Load
6285 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
6286 # and [Tracking Mode for Internal TCP/UDP Load
6287 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
6288 },
6289 &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
6290 # affinity based on HTTP headers, cookies or other properties. This load
6291 # balancing policy is applicable only for HTTP connections. The affinity to a
6292 # particular destination host will be lost when one or more hosts are
6293 # added/removed from the destination service. This field specifies parameters
6294 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
6295 #
6296 # This field is applicable to either:
6297 #
6298 # - A regional backend service with the service protocol set to HTTP,
6299 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
6300 # INTERNAL_MANAGED.
6301 # - A global backend service with the
6302 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
6303 &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
6304 # be used as the hash key for the consistent hash load balancer. If the
6305 # cookie is not present, it will be generated. This field is applicable if
6306 # the sessionAffinity is set to HTTP_COOKIE.
6307 #
6308 # Not supported when the backend service is referenced by a URL map that is
6309 # bound to target gRPC proxy that has validateForProxyless field set to true.
6310 # for load balancing policies that use a consistent hash.
6311 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
6312 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
6313 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
6314 # as a count of seconds and fractions of seconds at nanosecond
6315 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
6316 # or &quot;month&quot;. Range is approximately 10,000 years.
6317 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
6318 # Durations less than one second are represented with a 0
6319 # `seconds` field and a positive `nanos` field. Must be from 0
6320 # to 999,999,999 inclusive.
6321 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
6322 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
6323 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
6324 },
6325 },
6326 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
6327 # applicable if the sessionAffinity is set toHEADER_FIELD.
6328 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
6329 # 1024. Larger ring sizes result in more granular load distributions. If the
6330 # number of hosts in the load balancing pool is larger than the ring size,
6331 # each host will be assigned a single virtual node.
6332 },
6333 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
6334 # text format.
6335 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
6336 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
6337 # locality_lb_policy.
6338 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
6339 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
6340 # long and match the regular expression
6341 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
6342 # first character must be a lowercase letter, and all following
6343 # characters must be a dash, period, underscore, lowercase letter, or
6344 # digit, except the last character, which cannot be a dash, period, or
6345 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
6346 # field can only be used for a global or regional backend service with the
6347 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
6348 },
6349 ],
6350 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
6351 # custom
6352 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
6353 &quot;A String&quot;,
6354 ],
6355 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
6356 # custom
6357 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
6358 &quot;A String&quot;,
6359 ],
6360 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
6361 # create the resource.
6362 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
6363 # this backend service.
6364 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
6365 # global external Application Load Balancer.
6366 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
6367 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
6368 #
6369 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
6370 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
6371 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
6372 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
6373 # externalManagedMigrationTestingPercentage.
6374 #
6375 # Rolling back a migration requires the states to be set in reverse order. So
6376 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
6377 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
6378 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
6379 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
6380 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
6381 # external Application Load Balancer.
6382 #
6383 # The value of this field must be in the range [0, 100].
6384 #
6385 # Session affinity options will slightly affect this routing behavior, for
6386 # more details, see:Session
6387 # Affinity.
6388 #
6389 # This value can only be set if the loadBalancingScheme in the BackendService
6390 # is set to EXTERNAL (when using the classic Application Load Balancer) and
6391 # the migration state is TEST_BY_PERCENTAGE.
6392 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
6393 # as a backup (failover) backend.
6394 # For load balancers that have configurable failover:
6395 # [Internal passthrough Network Load
6396 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
6397 # and [external passthrough Network Load
6398 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
6399 #
6400 # failoverPolicy cannot be specified with haPolicy.
6401 # failover:
6402 # [Internal passthrough Network Load
6403 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
6404 # and [external passthrough
6405 # Network Load
6406 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
6407 # On failover or failback, this field indicates whether connection draining
6408 # will be honored. Google Cloud has a fixed connection draining timeout of
6409 # 10 minutes. A setting of true terminates existing TCP
6410 # connections to the active pool during failover and failback, immediately
6411 # draining traffic. A setting of false allows existing TCP
6412 # connections to persist, even on VMs no longer in the active pool, for up
6413 # to the duration of the connection draining timeout (10 minutes).
6414 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
6415 #
6416 # The default is false.
6417 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
6418 # load balancer are dropped when all primary and all backup backend VMs are
6419 # unhealthy.If set to false, connections are distributed
6420 # among all primary VMs when all primary and all backup backend VMs are
6421 # unhealthy.
6422 # For load balancers that have configurable
6423 # failover:
6424 # [Internal passthrough
6425 # Network Load
6426 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
6427 # and [external passthrough
6428 # Network Load
6429 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
6430 # The default is false.
6431 &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
6432 # failover when the number of healthy primary VMs equals zero.
6433 # For all other values, the load balancer performs a failover when the
6434 # total number of healthy primary VMs is less than this ratio.
6435 # For load balancers that have configurable
6436 # failover:
6437 # [Internal TCP/UDP Load
6438 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
6439 # and [external TCP/UDP Load
6440 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
6441 },
6442 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
6443 # This field is used in optimistic locking. This field will be ignored when
6444 # inserting a BackendService. An up-to-date fingerprint must be provided in
6445 # order to update the BackendService, otherwise the request will
6446 # fail with error 412 conditionNotMet.
6447 #
6448 # To see the latest fingerprint, make a get() request to
6449 # retrieve a BackendService.
6450 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
6451 # Protocol Forwarding.
6452 #
6453 # The backends of this regional backend service must only specify zonal
6454 # network endpoint groups (NEGs) of type GCE_VM_IP.
6455 #
6456 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
6457 # regional backend service must set the network field. All zonal NEGs must
6458 # belong to the same network. However, individual NEGs can
6459 # belong to different subnetworks of that network.
6460 #
6461 # When haPolicy is specified, the set of attached network endpoints across
6462 # all backends comprise an High Availability domain from which one endpoint
6463 # is selected as the active endpoint (the leader) that receives all
6464 # traffic.
6465 #
6466 # haPolicy can be added only at backend service creation time. Once set up,
6467 # it cannot be deleted.
6468 #
6469 # Note that haPolicy is not for load balancing, and therefore cannot be
6470 # specified with sessionAffinity, connectionTrackingPolicy, and
6471 # failoverPolicy.
6472 #
6473 # haPolicy requires customers to be responsible for tracking backend
6474 # endpoint health and electing a leader among the healthy endpoints.
6475 # Therefore, haPolicy cannot be specified with healthChecks.
6476 #
6477 # haPolicy can only be specified for External Passthrough Network Load
6478 # Balancers and Internal Passthrough Network Load Balancers.
6479 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
6480 # achieve it.
6481 #
6482 # Supported values are:
6483 #
6484 # - DISABLED: Fast IP Move is disabled. You can only use the
6485 # haPolicy.leader API to update the leader.
6486 # - &gt;GARP_RA: Provides a method to very quickly define a new network
6487 # endpoint as the leader. This method is faster than updating the leader
6488 # using the haPolicy.leader API. Fast IP move works as follows: The VM
6489 # hosting the network endpoint that should become the new leader sends
6490 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
6491 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
6492 # temporarily associates the forwarding rule IP address with that VM, and
6493 # both new and in-flight packets are quickly delivered to that VM.
6494 #
6495 #
6496 #
6497 # Note the important properties of the Fast IP Move functionality:
6498 #
6499 # - The GARP/RA-initiated re-routing stays active for approximately 20
6500 # minutes. After triggering fast failover, you must also
6501 # appropriately set the haPolicy.leader.
6502 # - The new leader instance should continue to send GARP/RA packets
6503 # periodically every 10 seconds until at least 10 minutes after updating
6504 # the haPolicy.leader (but stop immediately if it is no longer the leader).
6505 # - After triggering a fast failover, we recommend that you wait at least
6506 # 3 seconds before sending another GARP/RA packet from a different VM
6507 # instance to avoid race conditions.
6508 # - Don&#x27;t send GARP/RA packets from different VM
6509 # instances at the same time. If multiple instances continue to send
6510 # GARP/RA packets, traffic might be routed to different destinations in an
6511 # alternating order. This condition ceases when a single instance
6512 # issues a GARP/RA packet.
6513 # - The GARP/RA request always takes priority over the leader API.
6514 # Using the haPolicy.leader API to change the leader to a different
6515 # instance will have no effect until the GARP/RA request becomes
6516 # inactive.
6517 # - The GARP/RA packets should follow the GARP/RA
6518 # Packet Specifications..
6519 # - When multiple forwarding rules refer to a regional backend service,
6520 # you need only send a GARP or RA packet for a single forwarding rule
6521 # virtual IP. The virtual IPs for all forwarding rules targeting the same
6522 # backend service will also be moved to the sender of the GARP or RA
6523 # packet.
6524 #
6525 #
6526 #
6527 # The following are the Fast IP Move limitations (that is, when fastIPMove
6528 # is not DISABLED):
6529 #
6530 # - Multiple forwarding rules cannot use the same IP address if one of
6531 # them refers to a regional backend service with fastIPMove.
6532 # - The regional backend service must set the network field, and all
6533 # NEGs must belong to that network. However, individual
6534 # NEGs can belong to different subnetworks of that network.
6535 # - The maximum number of network endpoints across all backends of a
6536 # backend service with fastIPMove is 32.
6537 # - The maximum number of backend services with fastIPMove that can have
6538 # the same network endpoint attached to one of its backends is 64.
6539 # - The maximum number of backend services with fastIPMove in a VPC in a
6540 # region is 64.
6541 # - The network endpoints that are attached to a backend of a backend
6542 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
6543 # - Traffic directed to the leader by a static route next hop will not be
6544 # redirected to a new leader by fast failover. Such traffic will only be
6545 # redirected once an haPolicy.leader update has taken effect. Only traffic
6546 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
6547 # fast failover.
6548 #
6549 #
6550 # haPolicy.fastIPMove can be set only at backend service creation time.
6551 # Once set, it cannot be updated.
6552 #
6553 # By default, fastIpMove is set to DISABLED.
6554 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
6555 # this service as the active endpoint (the leader) that receives all
6556 # traffic.
6557 #
6558 # When the leader changes, there is no connection draining to persist
6559 # existing connections on the old leader.
6560 #
6561 # You are responsible for selecting a suitable endpoint as the
6562 # leader. For example, preferring a healthy endpoint over unhealthy ones.
6563 # Note that this service does not track backend endpoint health, and
6564 # selects the configured leader unconditionally.
6565 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
6566 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
6567 # that the leader is attached to.
6568 #
6569 # The leader&#x27;s backendGroup must already be specified as a backend of
6570 # this backend service. Removing a backend that is designated as the
6571 # leader&#x27;s backendGroup is not permitted.
6572 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
6573 # designated as the leader.
6574 #
6575 # This network endpoint cannot be detached from the NEG specified in
6576 # the haPolicy.leader.backendGroup until the leader is updated with
6577 # another network endpoint, or the leader is removed from the haPolicy.
6578 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
6579 # instance must already be attached to the NEG specified in the
6580 # haPolicy.leader.backendGroup.
6581 #
6582 # The name must be 1-63 characters long, and comply with RFC1035.
6583 # Authorization requires the following IAM permission on the
6584 # specified resource instance: compute.instances.use
6585 },
6586 },
6587 },
6588 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
6589 # httpsHealthChecks (legacy) resource for health checking this backend
6590 # service. Not all backend services support legacy health checks. See
6591 # Load balancer guide. Currently, at most one health check can be
6592 # specified for each backend service. Backend services with
6593 # instance group or zonal NEG backends must have a health check unless
6594 # haPolicy is specified. Backend services with internet or serverless NEG
6595 # backends must not have a health check.
6596 #
6597 # healthChecks[] cannot be specified with haPolicy.
6598 &quot;A String&quot;,
6599 ],
6600 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
6601 # Not available for internal passthrough Network Load Balancers and external
6602 # passthrough Network Load Balancers.
6603 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
6604 # incoming requests.
6605 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
6606 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
6607 # For security reasons, this value cannot be retrieved via the API.
6608 # Instead, the SHA-256 hash of the value is returned in the
6609 # oauth2ClientSecretSha256 field.
6610 #
6611 # @InputOnly
6612 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
6613 },
6614 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
6615 # defined by the server.
6616 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
6617 # from the client to the backend for proxyless gRPC).
6618 # The possible values are:
6619 #
6620 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
6621 # backend service (Instance Group, Managed Instance Group, Network Endpoint
6622 # Group), regardless of traffic from the client to the proxy. Only IPv4
6623 # health checks are used to check the health of the backends. This is the
6624 # default setting.
6625 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
6626 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
6627 # address).
6628 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
6629 # backend service (Instance Group, Managed Instance Group, Network Endpoint
6630 # Group), regardless of traffic from the client to the proxy. Only IPv6
6631 # health checks are used to check the health of the backends.
6632 #
6633 #
6634 #
6635 # This field is applicable to either:
6636 #
6637 # - Advanced global external Application Load Balancer (load balancing
6638 # scheme EXTERNAL_MANAGED),
6639 # - Regional external Application Load
6640 # Balancer,
6641 # - Internal proxy Network Load Balancer (load balancing
6642 # scheme INTERNAL_MANAGED),
6643 # - Regional internal Application Load
6644 # Balancer (load balancing scheme INTERNAL_MANAGED),
6645 # - Traffic
6646 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
6647 # INTERNAL_SELF_MANAGED).
6648 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
6649 # for backend services.
6650 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
6651 # created for one type of load balancer cannot be used with another.
6652 # For more information, refer toChoosing
6653 # a load balancer.
6654 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
6655 # preference. When you use localityLbPolicies, you must set at least one
6656 # value for either the localityLbPolicies[].policy or the
6657 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
6658 # value set in the localityLbPolicy field.
6659 #
6660 # For an example of how to use this field, seeDefine
6661 # a list of preferred policies.
6662 #
6663 # Caution: This field and its children are intended for use in a service mesh
6664 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
6665 # that have this configuration.
6666 { # Container for either a built-in LB policy supported by gRPC or Envoy or
6667 # a custom one implemented by the end user.
6668 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
6669 # deployed with the client.
6670 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
6671 # by a locally installed custom policy implementation.
6672 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
6673 #
6674 # The value should match the name of a custom implementation registered
6675 # on the gRPC clients. It should follow protocol buffer message naming
6676 # conventions and include the full path (for example,
6677 # myorg.CustomLbPolicy). The maximum length is 256 characters.
6678 #
6679 # Do not specify the same custom policy more than once for a
6680 # backend. If you do, the configuration is rejected.
6681 #
6682 # For an example of how to use this field, seeUse
6683 # a custom policy.
6684 },
6685 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
6686 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
6687 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
6688 # about these values, see the description of localityLbPolicy.
6689 #
6690 # Do not specify the same policy more than once for a
6691 # backend. If you do, the configuration is rejected.
6692 },
6693 },
6694 ],
6695 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
6696 # possible values are:
6697 #
6698 # - ROUND_ROBIN: This is a simple policy in which each healthy
6699 # backend is selected in round robin order. This is the default.
6700 # - LEAST_REQUEST: An O(1) algorithm which
6701 # selects two random healthy hosts and picks the host which has fewer active
6702 # requests.
6703 # - RING_HASH: The ring/modulo hash load balancer implements
6704 # consistent hashing to backends. The algorithm has the property that the
6705 # addition/removal of a host from a set of N hosts only affects 1/N of the
6706 # requests.
6707 # - RANDOM: The load balancer selects a random healthy
6708 # host.
6709 # - ORIGINAL_DESTINATION: Backend host is selected
6710 # based on the client connection metadata, i.e., connections are opened to
6711 # the same address as the destination address of the incoming connection
6712 # before the connection was redirected to the load balancer.
6713 # - MAGLEV: used as a drop in replacement for the ring hash
6714 # load balancer. Maglev is not as stable as ring hash but has faster table
6715 # lookup build times and host selection times. For more information about
6716 # Maglev, see Maglev:
6717 # A Fast and Reliable Software Network Load Balancer.
6718 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
6719 # Load Balancing using weights computed from Backend reported Custom Metrics.
6720 # If set, the Backend Service responses are expected to contain non-standard
6721 # HTTP response header field Endpoint-Load-Metrics. The reported
6722 # metrics to use for computing the weights are specified via thecustomMetrics field.
6723 #
6724 # This field is applicable to either:
6725 # - A regional backend service with the service protocol set to HTTP,
6726 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
6727 # INTERNAL_MANAGED.
6728 # - A global backend service with the
6729 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
6730 # EXTERNAL_MANAGED.
6731 #
6732 #
6733 # If sessionAffinity is not configured—that is, if session
6734 # affinity remains at the default value of NONE—then the
6735 # default value for localityLbPolicy
6736 # is ROUND_ROBIN. If session affinity is set to a value other
6737 # than NONE,
6738 # then the default value for localityLbPolicy isMAGLEV.
6739 #
6740 # Only ROUND_ROBIN and RING_HASH are supported
6741 # when the backend service is referenced by a URL map that is bound to
6742 # target gRPC proxy that has validateForProxyless field set to true.
6743 #
6744 # localityLbPolicy cannot be specified with haPolicy.
6745 &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
6746 # by this backend service. If logging is enabled, logs will be exported to
6747 # Stackdriver.
6748 # backend service.
6749 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
6750 # traffic served by this backend service. The default value is false.
6751 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
6752 { # Determines which HTTP headers will be logged to Stackdriver.
6753 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
6754 },
6755 ],
6756 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
6757 { # Determines which HTTP headers will be logged to Stackdriver.
6758 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
6759 },
6760 ],
6761 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
6762 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
6763 # of optional fields you want to include in the logs. For example:
6764 # serverInstance, serverGkeDetails.cluster,
6765 # serverGkeDetails.pod.podNamespace
6766 &quot;A String&quot;,
6767 ],
6768 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
6769 # service. Configures whether all, none or a subset of optional fields
6770 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
6771 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
6772 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
6773 # service. The value of the field must be in [0, 1]. This configures the
6774 # sampling rate of requests to the load balancer where 1.0 means all logged
6775 # requests are reported and 0.0 means no logged requests are reported. The
6776 # default value is 1.0.
6777 },
6778 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
6779 # service. Duration is computed from the beginning of the stream until the
6780 # response has been completely processed, including all retries. A stream
6781 # that does not complete in this duration is closed.
6782 #
6783 # If not specified, there will be no timeout limit, i.e. the maximum
6784 # duration is infinite.
6785 #
6786 # This value can be overridden in the PathMatcher configuration of the
6787 # UrlMap that references this backend service.
6788 #
6789 # This field is only allowed when the loadBalancingScheme of
6790 # the backend service is INTERNAL_SELF_MANAGED.
6791 # as a count of seconds and fractions of seconds at nanosecond
6792 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
6793 # or &quot;month&quot;. Range is approximately 10,000 years.
6794 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
6795 # Durations less than one second are represented with a 0
6796 # `seconds` field and a positive `nanos` field. Must be from 0
6797 # to 999,999,999 inclusive.
6798 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
6799 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
6800 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
6801 },
6802 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
6803 # controller and read by the backend RCTH
6804 &quot;a_key&quot;: &quot;A String&quot;,
6805 },
6806 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
6807 # The name must be 1-63 characters long, and comply withRFC1035.
6808 # Specifically, the name must be 1-63 characters long and match the regular
6809 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
6810 # character must be a lowercase letter, and all following characters must
6811 # be a dash, lowercase letter, or digit, except the last character, which
6812 # cannot be a dash.
6813 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
6814 #
6815 # This field must be set for Internal Passthrough Network Load Balancers when
6816 # the haPolicy is enabled, and for External Passthrough Network Load
6817 # Balancers when the haPolicy fastIpMove is enabled.
6818 #
6819 # 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.
6820 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
6821 # Load Balancers.
6822 #
6823 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
6824 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
6825 # endpoints in the local zone.
6826 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
6827 # possible values are:
6828 #
6829 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
6830 # is disabled. The load balancer distributes new connections to all
6831 # healthy backend endpoints across all zones.
6832 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
6833 # enabled. The load balancer distributes new connections to all healthy
6834 # backend endpoints in the local zone only. If there are no healthy
6835 # backend endpoints in the local zone, the load balancer distributes
6836 # new connections to all backend endpoints in the local zone.
6837 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
6838 # enabled. The load balancer distributes new connections to all healthy
6839 # backend endpoints in the local zone only. If there aren&#x27;t enough
6840 # healthy backend endpoints in the local zone, the load balancer
6841 # distributes new connections to all healthy backend endpoints across all
6842 # zones.
6843 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
6844 # of healthy backend endpoints in a zone to the count of backend
6845 # endpoints in that same zone is equal to or above this threshold, the
6846 # load balancer distributes new connections to all healthy endpoints in
6847 # the local zone only. When the ratio of the count of healthy backend
6848 # endpoints in a zone to the count of backend endpoints in that same
6849 # zone is below this threshold, the load balancer distributes all new
6850 # connections to all healthy endpoints across all zones.
6851 },
6852 },
6853 &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.
6854 # the backend service.
6855 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
6856 # service.
6857 },
6858 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
6859 # load balancing pool of each individual proxy instance that processes the
6860 # traffic for the given backend service. If not set, this feature is
6861 # considered disabled.
6862 #
6863 # Results of the outlier detection algorithm (ejection of endpoints from the
6864 # load balancing pool and returning them back to the pool) are executed
6865 # independently by each proxy instance of the load balancer. In most cases,
6866 # more than one proxy instance handles the traffic received by a backend
6867 # service. Thus, it is possible that an unhealthy endpoint is detected and
6868 # ejected by only some of the proxies, and while this happens, other proxies
6869 # may continue to send requests to the same unhealthy endpoint until they
6870 # detect and eject the unhealthy endpoint.
6871 #
6872 # Applicable backend endpoints can be:
6873 #
6874 # - VM instances in an Instance Group
6875 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
6876 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
6877 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
6878 # Functions Services
6879 # - Private Service Connect NEGs, that resolve to
6880 # Google-managed regional API endpoints or managed services published using
6881 # Private Service Connect
6882 #
6883 #
6884 #
6885 # Applicable backend service types can be:
6886 #
6887 # - A global backend service with the loadBalancingScheme set to
6888 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
6889 # - A regional backend
6890 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
6891 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
6892 # supported for Serverless NEGs.
6893 #
6894 #
6895 #
6896 # Not supported when the backend service is referenced by a URL map that is
6897 # bound to target gRPC proxy that has validateForProxyless field set to true.
6898 # pool for the backend service.
6899 &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
6900 # or 30s.
6901 #
6902 # After a backend endpoint is returned back to the load balancing pool, it
6903 # can be ejected again in another ejection analysis. Thus, the total ejection
6904 # time is equal to the base ejection time multiplied by the number of times
6905 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
6906 # as a count of seconds and fractions of seconds at nanosecond
6907 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
6908 # or &quot;month&quot;. Range is approximately 10,000 years.
6909 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
6910 # Durations less than one second are represented with a 0
6911 # `seconds` field and a positive `nanos` field. Must be from 0
6912 # to 999,999,999 inclusive.
6913 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
6914 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
6915 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
6916 },
6917 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
6918 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
6919 # return code qualifies as an error. Defaults to 5.
6920 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
6921 # connection errors that are mapped to one of those status codes) before a
6922 # consecutive gateway failure ejection occurs. Defaults to 3.
6923 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
6924 # outlier status is detected through consecutive 5xx. This setting can be
6925 # used to disable ejection or to ramp it up slowly. Defaults to 0.
6926 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
6927 # outlier status is detected through consecutive gateway failures. This
6928 # setting can be used to disable ejection or to ramp it up slowly. Defaults
6929 # to 100.
6930 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
6931 # outlier status is detected through success rate statistics. This setting
6932 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
6933 #
6934 # Not supported when the backend service uses Serverless NEG.
6935 &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
6936 # ejections and backend endpoints being returned to service. The interval is
6937 # equal to the number of seconds as defined in
6938 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
6939 # in outlierDetection.interval.nanos. Defaults to 1 second.
6940 # as a count of seconds and fractions of seconds at nanosecond
6941 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
6942 # or &quot;month&quot;. Range is approximately 10,000 years.
6943 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
6944 # Durations less than one second are represented with a 0
6945 # `seconds` field and a positive `nanos` field. Must be from 0
6946 # to 999,999,999 inclusive.
6947 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
6948 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
6949 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
6950 },
6951 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
6952 # backend service that can be ejected if the ejection conditions are met.
6953 # Defaults to 50%.
6954 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
6955 # enough request volume to detect success rate outliers. If the number of
6956 # backend endpoints is fewer than this setting, outlier detection via success
6957 # rate statistics is not performed for any backend endpoint in the load
6958 # balancing pool. Defaults to 5.
6959 #
6960 # Not supported when the backend service uses Serverless NEG.
6961 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
6962 # (as defined by the interval duration above) to include this backend
6963 # endpoint in success rate based outlier detection. If the volume is lower
6964 # than this setting, outlier detection via success rate statistics is not
6965 # performed for that backend endpoint. Defaults to 100.
6966 #
6967 # Not supported when the backend service uses Serverless NEG.
6968 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
6969 # outlier ejection. The ejection threshold is the difference between the mean
6970 # success rate, and the product of this factor and the standard deviation of
6971 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
6972 # is divided by a thousand to get a double. That is, if the desired factor
6973 # is 1.9, the runtime value should be 1900. Defaults to 1900.
6974 #
6975 # Not supported when the backend service uses Serverless NEG.
6976 },
6977 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
6978 # as part of resource payload.
6979 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
6980 # Tag keys and values have the same definition as resource
6981 # manager tags. The field is allowed for INSERT
6982 # only. The keys/values to set on the resource should be specified in
6983 # either ID { : } or Namespaced format
6984 # { : }.
6985 # For example the following are valid inputs:
6986 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
6987 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
6988 # Note:
6989 # * Invalid combinations of ID &amp; namespaced format is not supported. For
6990 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
6991 &quot;a_key&quot;: &quot;A String&quot;,
6992 },
6993 },
6994 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
6995 # the backend. The default value is 80.
6996 # For internal passthrough Network Load Balancers and external passthrough
6997 # Network Load Balancers, omit port.
6998 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
6999 # communication to the backend VMs in that group. The
7000 # named port must be [defined on each backend instance
7001 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
7002 # This parameter has no meaning if the backends are NEGs. For internal
7003 # passthrough Network Load Balancers and external passthrough Network Load
7004 # Balancers, omit port_name.
7005 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
7006 # with backends.
7007 #
7008 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
7009 # depending on the chosen load balancer or Traffic Director configuration.
7010 # Refer to the documentation for the load balancers or for Traffic Director
7011 # for more information.
7012 #
7013 # Must be set to GRPC when the backend service is referenced by a URL map
7014 # that is bound to target gRPC proxy.
7015 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
7016 # resides. This field is not applicable to global backend services.
7017 # You must specify this field as part of the HTTP request URL. It is
7018 # not settable as a field in the request body.
7019 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
7020 # backend service.
7021 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
7022 # service. This field is applicable to a global backend service with the
7023 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
7024 &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
7025 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
7026 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
7027 # private storage buckets that support Signature Version 4 for authentication.
7028 # The service name for generating the authentication header will always default
7029 # to &#x27;s3&#x27;.
7030 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
7031 # creating a backend that uses AWS v4 signature authentication, but will not
7032 # be returned as part of the configuration when queried with a REST API GET
7033 # request.
7034 #
7035 # @InputOnly
7036 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
7037 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
7038 # keep track of different iterations of your access key.
7039 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
7040 # the name of the region your cloud uses to host your origin. For example,
7041 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
7042 },
7043 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
7044 # that describes how clients should authenticate with this service&#x27;s
7045 # backends.
7046 #
7047 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
7048 # to INTERNAL_SELF_MANAGED.
7049 #
7050 # If left blank, communications are not encrypted.
7051 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
7052 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
7053 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
7054 # specified values, the communication continues. Otherwise, it fails. This
7055 # additional check enables the client to verify that the server is authorized
7056 # to run the requested service.
7057 #
7058 # Note that the contents of the server
7059 # certificate&#x27;s subjectAltName field are configured by the
7060 # Public Key Infrastructure which provisions server identities.
7061 #
7062 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
7063 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
7064 # mode).
7065 &quot;A String&quot;,
7066 ],
7067 },
7068 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7069 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
7070 #
7071 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
7072 # If set, lists of backends and health checks must be both empty.
7073 &quot;A String&quot;,
7074 ],
7075 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
7076 #
7077 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
7078 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
7079 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
7080 #
7081 # Only NONE and HEADER_FIELD are supported
7082 # when the backend service is referenced by a URL map that is bound to
7083 # target gRPC proxy that has validateForProxyless field set to true.
7084 #
7085 # For more details, see:
7086 # [Session
7087 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
7088 #
7089 # sessionAffinity cannot be specified with haPolicy.
7090 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
7091 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
7092 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
7093 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
7094 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
7095 # as a count of seconds and fractions of seconds at nanosecond
7096 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7097 # or &quot;month&quot;. Range is approximately 10,000 years.
7098 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7099 # Durations less than one second are represented with a 0
7100 # `seconds` field and a positive `nanos` field. Must be from 0
7101 # to 999,999,999 inclusive.
7102 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7103 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7104 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7105 },
7106 },
7107 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
7108 # Currently this is applicable only for Internal TCP/UDP load balancing,
7109 # Internal HTTP(S) load balancing and Traffic Director.
7110 &quot;policy&quot;: &quot;A String&quot;,
7111 },
7112 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
7113 # type of load balancer. For more information see,
7114 # Backend service settings.
7115 # The default is 30 seconds.
7116 # The full range of timeout values allowed goes from 1
7117 # through 2,147,483,647 seconds.
7118 #
7119 # This value can be overridden in the PathMatcher configuration of the
7120 # UrlMap that references this backend service.
7121 #
7122 # Not supported when the backend service is referenced by a URL map that is
7123 # bound to target gRPC proxy that has validateForProxyless field set to true.
7124 # Instead, use maxStreamDuration.
7125 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
7126 # when the backend protocol is SSL, HTTPS or HTTP2.
7127 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
7128 # networksecurity.googleapis.com namespace. Can be used in authenticating
7129 # TLS connections to the backend, as specified by the authenticationMode
7130 # field. Can only be specified if authenticationMode is not NONE.
7131 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
7132 # balancer sends this string as the SNI hostname in the TLS connection to
7133 # the backend, and requires that this string match a Subject Alternative
7134 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
7135 # NEG backend, if the SNI is specified here, the load balancer uses it
7136 # regardless of whether the Regional Internet NEG is specified with FQDN or
7137 # IP address and port. When both sni and subjectAltNames[] are specified,
7138 # the load balancer matches the backend certificate&#x27;s SAN only to
7139 # subjectAltNames[].
7140 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
7141 # verifies during a TLS handshake with the backend. When the server
7142 # presents its X.509 certificate to the Load Balancer, the Load Balancer
7143 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
7144 # match one of the subjectAltNames in the list. This field is limited to 5
7145 # entries. When both sni and subjectAltNames[] are specified, the load
7146 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
7147 { # A Subject Alternative Name that the load balancer matches against the SAN
7148 # field in the TLS certificate provided by the backend, specified as either
7149 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
7150 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
7151 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
7152 },
7153 ],
7154 },
7155 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
7156 {
7157 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
7158 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
7159 # and ForwardingRule.
7160 },
7161 ],
7162 },
7163 ],
7164 &quot;kind&quot;: &quot;compute#backendServiceList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#backendServiceList for lists of backend services.
7165 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
7166 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
7167 # the query parameter pageToken in the next list request.
7168 # Subsequent list requests will have their own nextPageToken to
7169 # continue paging through the results.
7170 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
7171 &quot;warning&quot;: { # [Output Only] Informational warning message.
7172 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
7173 # Engine returns NO_RESULTS_ON_PAGE if there
7174 # are no results in the response.
7175 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
7176 # value format. For example:
7177 #
7178 # &quot;data&quot;: [
7179 # {
7180 # &quot;key&quot;: &quot;scope&quot;,
7181 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
7182 # }
7183 {
7184 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
7185 # returned. For example, for warnings where there are no results in a list
7186 # request for a particular zone, this key might be scope and
7187 # the key value might be the zone name. Other examples might be a key
7188 # indicating a deprecated resource and a suggested replacement, or a
7189 # warning about invalid network settings (for example, if an instance
7190 # attempts to perform IP forwarding but is not enabled for IP forwarding).
7191 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
7192 },
7193 ],
7194 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
7195 },
7196 }</pre>
7197 </div>
7198
7199 <div class="method">
7200 <code class="details" id="listUsable">listUsable(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
7201 <pre>Retrieves a list of all usable backend services in the specified project.
7202
7203 Args:
7204 project: string, Project ID for this request. (required)
7205 filter: string, A filter expression that filters resources listed in the response. Most
7206 Compute resources support two types of filter expressions:
7207 expressions that support regular expressions and expressions that follow
7208 API improvement proposal AIP-160.
7209 These two types of filter expressions cannot be mixed in one request.
7210
7211 If you want to use AIP-160, your expression must specify the field name, an
7212 operator, and the value that you want to use for filtering. The value
7213 must be a string, a number, or a boolean. The operator
7214 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
7215
7216 For example, if you are filtering Compute Engine instances, you can
7217 exclude instances named `example-instance` by specifying
7218 `name != example-instance`.
7219
7220 The `:*` comparison can be used to test whether a key has been defined.
7221 For example, to find all objects with `owner` label use:
7222 ```
7223 labels.owner:*
7224 ```
7225
7226 You can also filter nested fields. For example, you could specify
7227 `scheduling.automaticRestart = false` to include instances only
7228 if they are not scheduled for automatic restarts. You can use filtering
7229 on nested fields to filter based onresource labels.
7230
7231 To filter on multiple expressions, provide each separate expression within
7232 parentheses. For example:
7233 ```
7234 (scheduling.automaticRestart = true)
7235 (cpuPlatform = &quot;Intel Skylake&quot;)
7236 ```
7237 By default, each expression is an `AND` expression. However, you
7238 can include `AND` and `OR` expressions explicitly.
7239 For example:
7240 ```
7241 (cpuPlatform = &quot;Intel Skylake&quot;) OR
7242 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
7243 (scheduling.automaticRestart = true)
7244 ```
7245
7246 If you want to use a regular expression, use the `eq` (equal) or `ne`
7247 (not equal) operator against a single un-parenthesized expression with or
7248 without quotes or against multiple parenthesized expressions. Examples:
7249
7250 `fieldname eq unquoted literal`
7251 `fieldname eq &#x27;single quoted literal&#x27;`
7252 `fieldname eq &quot;double quoted literal&quot;`
7253 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
7254
7255 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
7256 The literal value must match the entire field.
7257
7258 For example, to filter for instances that do not end with name &quot;instance&quot;,
7259 you would use `name ne .*instance`.
7260
7261 You cannot combine constraints on multiple fields using regular
7262 expressions.
7263 maxResults: integer, The maximum number of results per page that should be returned.
7264 If the number of available results is larger than `maxResults`,
7265 Compute Engine returns a `nextPageToken` that can be used to get
7266 the next page of results in subsequent list requests. Acceptable values are
7267 `0` to `500`, inclusive. (Default: `500`)
7268 orderBy: string, Sorts list results by a certain order. By default, results
7269 are returned in alphanumerical order based on the resource name.
7270
7271 You can also sort results in descending order based on the creation
7272 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
7273 results based on the `creationTimestamp` field in
7274 reverse chronological order (newest result first). Use this to sort
7275 resources like operations so that the newest operation is returned first.
7276
7277 Currently, only sorting by `name` or
7278 `creationTimestamp desc` is supported.
7279 pageToken: string, Specifies a page token to use. Set `pageToken` to the
7280 `nextPageToken` returned by a previous list request to get
7281 the next page of results.
7282 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
7283 of failure. The default value is false.
7284
7285 For example, when partial success behavior is enabled, aggregatedList for a
7286 single zone scope either returns all resources in the zone or no resources,
7287 with an error code.
7288 x__xgafv: string, V1 error format.
7289 Allowed values
7290 1 - v1 error format
7291 2 - v2 error format
7292
7293 Returns:
7294 An object of the form:
7295
7296 { # Contains a list of usable BackendService resources.
7297 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
7298 &quot;items&quot;: [ # A list of BackendService resources.
7299 { # Represents a Backend Service resource.
7300 #
7301 # A backend service defines how Google Cloud load balancers distribute traffic.
7302 # The backend service configuration contains a set of values, such as the
7303 # protocol used to connect to backends, various distribution and session
7304 # settings, health checks, and timeouts. These settings provide fine-grained
7305 # control over how your load balancer behaves. Most of the settings have
7306 # default values that allow for easy configuration if you need to get started
7307 # quickly.
7308 #
7309 # Backend services in Google Compute Engine can be either regionally or
7310 # globally scoped.
7311 #
7312 # * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices)
7313 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices)
7314 #
7315 # For more information, seeBackend
7316 # Services.
7317 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
7318 # Load Balancers and Traffic Director and requires
7319 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
7320 #
7321 # If set to 0, the cookie is non-persistent and lasts only until
7322 # the end of the browser session (or equivalent). The maximum allowed value
7323 # is two weeks (1,209,600).
7324 #
7325 # Not supported when the backend service is referenced by a URL map that is
7326 # bound to target gRPC proxy that has validateForProxyless field set to true.
7327 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
7328 { # Message containing information of one individual backend.
7329 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
7330 # handle additional traffic or is fully loaded. For usage guidelines, see
7331 # Connection balancing mode.
7332 #
7333 # Backends must use compatible balancing modes. For more information, see
7334 # Supported balancing modes and target capacity settings and
7335 # Restrictions and guidance for instance groups.
7336 #
7337 # Note: Currently, if you use the API to configure incompatible balancing
7338 # modes, the configuration might be accepted even though it has no impact
7339 # and is ignored. Specifically, Backend.maxUtilization is ignored when
7340 # Backend.balancingMode is RATE. In the future, this incompatible combination
7341 # will be rejected.
7342 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
7343 # mode.
7344 # The default value is 1, which means the group serves up to
7345 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
7346 # completely drained, offering 0% of its available capacity. The valid ranges
7347 # are 0.0 and [0.1,1.0].
7348 # You cannot configure a setting larger than 0 and smaller than0.1.
7349 # You cannot configure a setting of 0 when there is only one
7350 # backend attached to the backend service.
7351 #
7352 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
7353 # internet NEGs, regional serverless NEGs, and PSC NEGs.
7354 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
7355 # BalancingMode.
7356 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
7357 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
7358 # Monitoring, but is not used for load balancing.
7359 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
7360 # balancing mode. The valid range is [0.0, 1.0].
7361 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
7362 # long and match the regular expression
7363 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
7364 # first character must be a lowercase letter, and all following
7365 # characters must be a dash, period, underscore, lowercase letter, or
7366 # digit, except the last character, which cannot be a dash, period, or
7367 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
7368 # field can only be used for a global or regional backend service with the
7369 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
7370 },
7371 ],
7372 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
7373 # create the resource.
7374 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
7375 # failover backend can be configured for a given BackendService.
7376 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
7377 # group or network endpoint
7378 # group (NEG) resource. To determine what types of backends a load
7379 # balancer supports, see the [Backend services
7380 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
7381 #
7382 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
7383 # or NEG. Partial URLs are not supported.
7384 #
7385 # If haPolicy is specified, backends must refer to NEG resources of type
7386 # GCE_VM_IP.
7387 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
7388 # guidelines, seeConnection
7389 # balancing mode and Utilization
7390 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
7391 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
7392 # guidelines, seeConnection
7393 # balancing mode and Utilization
7394 # balancing mode.
7395 #
7396 # Not available if the backend&#x27;s balancingMode isRATE.
7397 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
7398 # For usage guidelines, seeConnection
7399 # balancing mode and Utilization
7400 # balancing mode.
7401 #
7402 # Not available if the backend&#x27;s balancingMode isRATE.
7403 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
7404 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
7405 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
7406 # Not available if backend&#x27;s balancingMode is RATE
7407 # or CONNECTION.
7408 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
7409 # Not available if backend&#x27;s balancingMode is RATE
7410 # or CONNECTION.
7411 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
7412 # usage guidelines, seeRate
7413 # balancing mode and Utilization
7414 # balancing mode.
7415 #
7416 # Not available if the backend&#x27;s balancingMode isCONNECTION.
7417 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
7418 # guidelines, seeRate
7419 # balancing mode and Utilization
7420 # balancing mode.
7421 #
7422 # Not available if the backend&#x27;s balancingMode isCONNECTION.
7423 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
7424 # guidelines, seeRate
7425 # balancing mode and Utilization
7426 # balancing mode.
7427 #
7428 # Not available if the backend&#x27;s balancingMode isCONNECTION.
7429 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
7430 #
7431 # For usage guidelines, seeUtilization
7432 # balancing mode.
7433 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
7434 # the backend.
7435 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
7436 },
7437 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
7438 # sending traffic to backends with default preference. The possible values
7439 # are:
7440 #
7441 # - PREFERRED: Backends with this preference level will be
7442 # filled up to their capacity limits first, based on RTT.
7443 # - DEFAULT: If preferred backends don&#x27;t have enough
7444 # capacity, backends in this layer would be used and traffic would be
7445 # assigned based on the load balancing algorithm you use. This is the
7446 # default
7447 &quot;trafficDuration&quot;: &quot;A String&quot;,
7448 },
7449 ],
7450 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
7451 # specified load balancer types.
7452 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
7453 # Pragma or Authorization headers. Up to 5 headers can be specified.
7454 # The cache is bypassed for all cdnPolicy.cacheMode settings.
7455 { # Bypass the cache when the specified request headers are present,
7456 # e.g. Pragma or Authorization headers. Values are case insensitive.
7457 # The presence of such a header overrides the cache_mode setting.
7458 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
7459 # Values are case-insensitive.
7460 },
7461 ],
7462 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
7463 # CDN.
7464 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
7465 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
7466 &quot;A String&quot;,
7467 ],
7468 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
7469 # The name=value pair will be used in the cache key Cloud CDN generates.
7470 &quot;A String&quot;,
7471 ],
7472 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
7473 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
7474 # query_string_whitelist and query_string_blacklist. If neither is set, the
7475 # entire query string will be included. If false, the query string will be
7476 # excluded from the cache key entirely.
7477 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
7478 # parameters will be included. Either specify query_string_whitelist or
7479 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
7480 # not treated as delimiters.
7481 &quot;A String&quot;,
7482 ],
7483 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
7484 # parameters will be excluded. Either specify query_string_whitelist or
7485 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
7486 # not treated as delimiters.
7487 &quot;A String&quot;,
7488 ],
7489 },
7490 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
7491 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
7492 # headers to cache content. Responses without these headers will not be
7493 # cached at Google&#x27;s edge, and will require a full trip to the origin on
7494 # every request, potentially impacting performance and increasing load on
7495 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
7496 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
7497 # Warning: this may result in Cloud CDN caching private,
7498 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
7499 # including common image formats, media (video and audio), and web assets
7500 # (JavaScript and CSS). Requests and responses that are marked as
7501 # uncacheable, as well as dynamic content (including HTML), will not be
7502 # cached.
7503 #
7504 # If no value is provided for cdnPolicy.cacheMode, it defaults
7505 # to CACHE_ALL_STATIC.
7506 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
7507 # used to clamp the max-age (or Expires) value sent to the client. With
7508 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
7509 # response max-age directive, along with a &quot;public&quot; directive. For
7510 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
7511 # from the origin (if specified), or else sets the response max-age
7512 # directive to the lesser of the client_ttl and default_ttl, and also
7513 # ensures a &quot;public&quot; cache-control directive is present.
7514 # If a client TTL is not specified, a default value (1 hour) will be used.
7515 # The maximum allowed value is 31,622,400s (1 year).
7516 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
7517 # responses that do not have an existing valid TTL (max-age or s-maxage).
7518 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
7519 # The value of defaultTTL cannot be set to a value greater than that of
7520 # maxTTL, but can be equal.
7521 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
7522 # will overwrite the TTL set in all responses. The maximum allowed value is
7523 # 31,622,400s (1 year), noting that infrequently accessed objects may be
7524 # evicted from the cache before the defined TTL.
7525 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
7526 # origin.
7527 # Cache directives that attempt to set a max-age or s-maxage higher than
7528 # this, or an Expires header more than maxTTL seconds in the future will
7529 # be capped at the value of maxTTL, as if it were the value of an
7530 # s-maxage Cache-Control directive.
7531 # Headers sent to the client will not be modified.
7532 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
7533 # The maximum allowed value is 31,622,400s (1 year), noting that
7534 # infrequently accessed objects may be evicted from the cache before
7535 # the defined TTL.
7536 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
7537 # to apply fine-grained caching for common errors or redirects.
7538 # This can reduce the load on your origin and improve end-user
7539 # experience by reducing response latency.
7540 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
7541 # negative caching applies to responses with the specified response code
7542 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
7543 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
7544 # to all responses with the specified response code, and override any
7545 # caching headers.
7546 # By default, Cloud CDN will apply the following default TTLs to these
7547 # status codes:
7548 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
7549 # HTTP 404 (Not Found), 410 (Gone),
7550 # 451 (Unavailable For Legal Reasons): 120s
7551 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
7552 # These defaults can be overridden in negative_caching_policy.
7553 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
7554 # negative_caching must be enabled to configure negative_caching_policy.
7555 # Omitting the policy and leaving negative_caching enabled will use
7556 # Cloud CDN&#x27;s default cache TTLs.
7557 # Note that when specifying an explicit negative_caching_policy, you
7558 # should take care to specify a cache TTL for all response codes
7559 # that you wish to cache. Cloud CDN will not apply any default
7560 # negative caching when a policy exists.
7561 { # Specify CDN TTLs for response error codes.
7562 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
7563 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
7564 # specified as values, and you cannot specify a status code more than
7565 # once.
7566 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
7567 # corresponding status code.
7568 # The maximum allowed value is 1800s (30 minutes), noting that
7569 # infrequently accessed objects may be evicted from the cache before the
7570 # defined TTL.
7571 },
7572 ],
7573 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
7574 # requests into a small number of requests to the origin.
7575 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
7576 # content with the origin, or when an error is encountered when refreshing
7577 # the cache.
7578 # This setting defines the default &quot;max-stale&quot; duration for any cached
7579 # responses that do not specify a max-stale directive. Stale responses that
7580 # exceed the TTL configured here will not be served. The default limit
7581 # (max-stale) is 86400s (1 day), which will allow stale content to be
7582 # served up to this limit beyond the max-age (or s-maxage) of a cached
7583 # response.
7584 # The maximum allowed value is 604800 (1 week).
7585 # Set this to zero (0) to disable serve-while-stale.
7586 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
7587 # considered fresh. After this time period, the response will be
7588 # revalidated before being served. Defaults to 1hr (3600s). When serving
7589 # responses to signed URL requests, Cloud CDN will internally behave as
7590 # though all responses from this backend had a &quot;Cache-Control:
7591 # public, max-age=[TTL]&quot; header, regardless of any existing
7592 # Cache-Control header. The actual headers served in responses will not be
7593 # altered.
7594 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
7595 &quot;A String&quot;,
7596 ],
7597 },
7598 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
7599 # backend service.
7600 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
7601 # there is no limit.
7602 #
7603 # Not supported when the backend service is referenced by a URL map that is
7604 # bound to target gRPC proxy that has validateForProxyless field set to true.
7605 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
7606 # not specified, there is no limit.
7607 #
7608 # Not supported when the backend service is referenced by a URL map that is
7609 # bound to target gRPC proxy that has validateForProxyless field set to true.
7610 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
7611 # service. If not specified, there is no limit.
7612 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
7613 # This parameter is respected by both the HTTP/1.1 and HTTP/2
7614 # implementations. If not specified, there is no limit. Setting this
7615 # parameter to 1 will effectively disable keep alive.
7616 #
7617 # Not supported when the backend service is referenced by a URL map that is
7618 # bound to target gRPC proxy that has validateForProxyless field set to true.
7619 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
7620 # not specified, the default is 1.
7621 #
7622 # Not supported when the backend service is referenced by a URL map that is
7623 # bound to target gRPC proxy that has validateForProxyless field set to true.
7624 },
7625 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
7626 # the client&#x27;s Accept-Encoding header.
7627 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
7628 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
7629 # instance. For supported load balancers and protocols, as described inEnabling
7630 # connection draining.
7631 },
7632 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
7633 # tracking policy settings are only available for external passthrough
7634 # Network Load Balancers and internal passthrough Network Load Balancers.
7635 #
7636 # connectionTrackingPolicy cannot be specified with haPolicy.
7637 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
7638 # value is DEFAULT_FOR_PROTOCOL.
7639 #
7640 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
7641 # persist on unhealthy backends only for connection-oriented protocols
7642 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
7643 # Affinity is configured for 5-tuple. They do not persist forUDP.
7644 #
7645 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
7646 # the existing connections on the unhealthy backend are never persisted on
7647 # the unhealthy backend. They are always diverted to newly selected healthy
7648 # backends (unless all backends are unhealthy).
7649 #
7650 # If set to ALWAYS_PERSIST, existing connections always
7651 # persist on unhealthy backends regardless of protocol and session
7652 # affinity. It is generally not recommended to use this mode overriding the
7653 # default.
7654 #
7655 # For more details, see [Connection Persistence for Network Load
7656 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
7657 # and [Connection Persistence for Internal TCP/UDP Load
7658 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
7659 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
7660 # Balancers. This option is not available publicly.
7661 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
7662 # matching traffic (in seconds).
7663 #
7664 # For internal passthrough Network Load Balancers:
7665 #
7666 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
7667 # - It can be set only if Connection Tracking is less than 5-tuple
7668 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
7669 # Mode is PER_SESSION).
7670 #
7671 #
7672 #
7673 # For external passthrough Network Load Balancers the default is 60
7674 # seconds. This option is not available publicly.
7675 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
7676 # options:
7677 #
7678 # - PER_CONNECTION: This is the default mode. The Connection
7679 # Tracking is performed as per the Connection Key (default Hash Method) for
7680 # the specific protocol.
7681 # - PER_SESSION: The Connection Tracking is performed as per
7682 # the configured Session Affinity. It matches the configured Session
7683 # Affinity.
7684 #
7685 #
7686 #
7687 # For more details, see [Tracking Mode for Network Load
7688 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
7689 # and [Tracking Mode for Internal TCP/UDP Load
7690 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
7691 },
7692 &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
7693 # affinity based on HTTP headers, cookies or other properties. This load
7694 # balancing policy is applicable only for HTTP connections. The affinity to a
7695 # particular destination host will be lost when one or more hosts are
7696 # added/removed from the destination service. This field specifies parameters
7697 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
7698 #
7699 # This field is applicable to either:
7700 #
7701 # - A regional backend service with the service protocol set to HTTP,
7702 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
7703 # INTERNAL_MANAGED.
7704 # - A global backend service with the
7705 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
7706 &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
7707 # be used as the hash key for the consistent hash load balancer. If the
7708 # cookie is not present, it will be generated. This field is applicable if
7709 # the sessionAffinity is set to HTTP_COOKIE.
7710 #
7711 # Not supported when the backend service is referenced by a URL map that is
7712 # bound to target gRPC proxy that has validateForProxyless field set to true.
7713 # for load balancing policies that use a consistent hash.
7714 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
7715 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
7716 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
7717 # as a count of seconds and fractions of seconds at nanosecond
7718 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
7719 # or &quot;month&quot;. Range is approximately 10,000 years.
7720 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
7721 # Durations less than one second are represented with a 0
7722 # `seconds` field and a positive `nanos` field. Must be from 0
7723 # to 999,999,999 inclusive.
7724 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
7725 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
7726 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
7727 },
7728 },
7729 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
7730 # applicable if the sessionAffinity is set toHEADER_FIELD.
7731 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
7732 # 1024. Larger ring sizes result in more granular load distributions. If the
7733 # number of hosts in the load balancing pool is larger than the ring size,
7734 # each host will be assigned a single virtual node.
7735 },
7736 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
7737 # text format.
7738 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
7739 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
7740 # locality_lb_policy.
7741 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
7742 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
7743 # long and match the regular expression
7744 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
7745 # first character must be a lowercase letter, and all following
7746 # characters must be a dash, period, underscore, lowercase letter, or
7747 # digit, except the last character, which cannot be a dash, period, or
7748 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
7749 # field can only be used for a global or regional backend service with the
7750 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
7751 },
7752 ],
7753 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
7754 # custom
7755 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
7756 &quot;A String&quot;,
7757 ],
7758 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
7759 # custom
7760 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
7761 &quot;A String&quot;,
7762 ],
7763 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
7764 # create the resource.
7765 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
7766 # this backend service.
7767 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
7768 # global external Application Load Balancer.
7769 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
7770 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
7771 #
7772 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
7773 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
7774 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
7775 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
7776 # externalManagedMigrationTestingPercentage.
7777 #
7778 # Rolling back a migration requires the states to be set in reverse order. So
7779 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
7780 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
7781 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
7782 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
7783 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
7784 # external Application Load Balancer.
7785 #
7786 # The value of this field must be in the range [0, 100].
7787 #
7788 # Session affinity options will slightly affect this routing behavior, for
7789 # more details, see:Session
7790 # Affinity.
7791 #
7792 # This value can only be set if the loadBalancingScheme in the BackendService
7793 # is set to EXTERNAL (when using the classic Application Load Balancer) and
7794 # the migration state is TEST_BY_PERCENTAGE.
7795 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
7796 # as a backup (failover) backend.
7797 # For load balancers that have configurable failover:
7798 # [Internal passthrough Network Load
7799 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
7800 # and [external passthrough Network Load
7801 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
7802 #
7803 # failoverPolicy cannot be specified with haPolicy.
7804 # failover:
7805 # [Internal passthrough Network Load
7806 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
7807 # and [external passthrough
7808 # Network Load
7809 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
7810 # On failover or failback, this field indicates whether connection draining
7811 # will be honored. Google Cloud has a fixed connection draining timeout of
7812 # 10 minutes. A setting of true terminates existing TCP
7813 # connections to the active pool during failover and failback, immediately
7814 # draining traffic. A setting of false allows existing TCP
7815 # connections to persist, even on VMs no longer in the active pool, for up
7816 # to the duration of the connection draining timeout (10 minutes).
7817 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
7818 #
7819 # The default is false.
7820 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
7821 # load balancer are dropped when all primary and all backup backend VMs are
7822 # unhealthy.If set to false, connections are distributed
7823 # among all primary VMs when all primary and all backup backend VMs are
7824 # unhealthy.
7825 # For load balancers that have configurable
7826 # failover:
7827 # [Internal passthrough
7828 # Network Load
7829 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
7830 # and [external passthrough
7831 # Network Load
7832 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
7833 # The default is false.
7834 &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
7835 # failover when the number of healthy primary VMs equals zero.
7836 # For all other values, the load balancer performs a failover when the
7837 # total number of healthy primary VMs is less than this ratio.
7838 # For load balancers that have configurable
7839 # failover:
7840 # [Internal TCP/UDP Load
7841 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
7842 # and [external TCP/UDP Load
7843 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
7844 },
7845 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
7846 # This field is used in optimistic locking. This field will be ignored when
7847 # inserting a BackendService. An up-to-date fingerprint must be provided in
7848 # order to update the BackendService, otherwise the request will
7849 # fail with error 412 conditionNotMet.
7850 #
7851 # To see the latest fingerprint, make a get() request to
7852 # retrieve a BackendService.
7853 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
7854 # Protocol Forwarding.
7855 #
7856 # The backends of this regional backend service must only specify zonal
7857 # network endpoint groups (NEGs) of type GCE_VM_IP.
7858 #
7859 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
7860 # regional backend service must set the network field. All zonal NEGs must
7861 # belong to the same network. However, individual NEGs can
7862 # belong to different subnetworks of that network.
7863 #
7864 # When haPolicy is specified, the set of attached network endpoints across
7865 # all backends comprise an High Availability domain from which one endpoint
7866 # is selected as the active endpoint (the leader) that receives all
7867 # traffic.
7868 #
7869 # haPolicy can be added only at backend service creation time. Once set up,
7870 # it cannot be deleted.
7871 #
7872 # Note that haPolicy is not for load balancing, and therefore cannot be
7873 # specified with sessionAffinity, connectionTrackingPolicy, and
7874 # failoverPolicy.
7875 #
7876 # haPolicy requires customers to be responsible for tracking backend
7877 # endpoint health and electing a leader among the healthy endpoints.
7878 # Therefore, haPolicy cannot be specified with healthChecks.
7879 #
7880 # haPolicy can only be specified for External Passthrough Network Load
7881 # Balancers and Internal Passthrough Network Load Balancers.
7882 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
7883 # achieve it.
7884 #
7885 # Supported values are:
7886 #
7887 # - DISABLED: Fast IP Move is disabled. You can only use the
7888 # haPolicy.leader API to update the leader.
7889 # - &gt;GARP_RA: Provides a method to very quickly define a new network
7890 # endpoint as the leader. This method is faster than updating the leader
7891 # using the haPolicy.leader API. Fast IP move works as follows: The VM
7892 # hosting the network endpoint that should become the new leader sends
7893 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
7894 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
7895 # temporarily associates the forwarding rule IP address with that VM, and
7896 # both new and in-flight packets are quickly delivered to that VM.
7897 #
7898 #
7899 #
7900 # Note the important properties of the Fast IP Move functionality:
7901 #
7902 # - The GARP/RA-initiated re-routing stays active for approximately 20
7903 # minutes. After triggering fast failover, you must also
7904 # appropriately set the haPolicy.leader.
7905 # - The new leader instance should continue to send GARP/RA packets
7906 # periodically every 10 seconds until at least 10 minutes after updating
7907 # the haPolicy.leader (but stop immediately if it is no longer the leader).
7908 # - After triggering a fast failover, we recommend that you wait at least
7909 # 3 seconds before sending another GARP/RA packet from a different VM
7910 # instance to avoid race conditions.
7911 # - Don&#x27;t send GARP/RA packets from different VM
7912 # instances at the same time. If multiple instances continue to send
7913 # GARP/RA packets, traffic might be routed to different destinations in an
7914 # alternating order. This condition ceases when a single instance
7915 # issues a GARP/RA packet.
7916 # - The GARP/RA request always takes priority over the leader API.
7917 # Using the haPolicy.leader API to change the leader to a different
7918 # instance will have no effect until the GARP/RA request becomes
7919 # inactive.
7920 # - The GARP/RA packets should follow the GARP/RA
7921 # Packet Specifications..
7922 # - When multiple forwarding rules refer to a regional backend service,
7923 # you need only send a GARP or RA packet for a single forwarding rule
7924 # virtual IP. The virtual IPs for all forwarding rules targeting the same
7925 # backend service will also be moved to the sender of the GARP or RA
7926 # packet.
7927 #
7928 #
7929 #
7930 # The following are the Fast IP Move limitations (that is, when fastIPMove
7931 # is not DISABLED):
7932 #
7933 # - Multiple forwarding rules cannot use the same IP address if one of
7934 # them refers to a regional backend service with fastIPMove.
7935 # - The regional backend service must set the network field, and all
7936 # NEGs must belong to that network. However, individual
7937 # NEGs can belong to different subnetworks of that network.
7938 # - The maximum number of network endpoints across all backends of a
7939 # backend service with fastIPMove is 32.
7940 # - The maximum number of backend services with fastIPMove that can have
7941 # the same network endpoint attached to one of its backends is 64.
7942 # - The maximum number of backend services with fastIPMove in a VPC in a
7943 # region is 64.
7944 # - The network endpoints that are attached to a backend of a backend
7945 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
7946 # - Traffic directed to the leader by a static route next hop will not be
7947 # redirected to a new leader by fast failover. Such traffic will only be
7948 # redirected once an haPolicy.leader update has taken effect. Only traffic
7949 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
7950 # fast failover.
7951 #
7952 #
7953 # haPolicy.fastIPMove can be set only at backend service creation time.
7954 # Once set, it cannot be updated.
7955 #
7956 # By default, fastIpMove is set to DISABLED.
7957 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
7958 # this service as the active endpoint (the leader) that receives all
7959 # traffic.
7960 #
7961 # When the leader changes, there is no connection draining to persist
7962 # existing connections on the old leader.
7963 #
7964 # You are responsible for selecting a suitable endpoint as the
7965 # leader. For example, preferring a healthy endpoint over unhealthy ones.
7966 # Note that this service does not track backend endpoint health, and
7967 # selects the configured leader unconditionally.
7968 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
7969 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
7970 # that the leader is attached to.
7971 #
7972 # The leader&#x27;s backendGroup must already be specified as a backend of
7973 # this backend service. Removing a backend that is designated as the
7974 # leader&#x27;s backendGroup is not permitted.
7975 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
7976 # designated as the leader.
7977 #
7978 # This network endpoint cannot be detached from the NEG specified in
7979 # the haPolicy.leader.backendGroup until the leader is updated with
7980 # another network endpoint, or the leader is removed from the haPolicy.
7981 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
7982 # instance must already be attached to the NEG specified in the
7983 # haPolicy.leader.backendGroup.
7984 #
7985 # The name must be 1-63 characters long, and comply with RFC1035.
7986 # Authorization requires the following IAM permission on the
7987 # specified resource instance: compute.instances.use
7988 },
7989 },
7990 },
7991 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
7992 # httpsHealthChecks (legacy) resource for health checking this backend
7993 # service. Not all backend services support legacy health checks. See
7994 # Load balancer guide. Currently, at most one health check can be
7995 # specified for each backend service. Backend services with
7996 # instance group or zonal NEG backends must have a health check unless
7997 # haPolicy is specified. Backend services with internet or serverless NEG
7998 # backends must not have a health check.
7999 #
8000 # healthChecks[] cannot be specified with haPolicy.
8001 &quot;A String&quot;,
8002 ],
8003 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
8004 # Not available for internal passthrough Network Load Balancers and external
8005 # passthrough Network Load Balancers.
8006 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
8007 # incoming requests.
8008 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
8009 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
8010 # For security reasons, this value cannot be retrieved via the API.
8011 # Instead, the SHA-256 hash of the value is returned in the
8012 # oauth2ClientSecretSha256 field.
8013 #
8014 # @InputOnly
8015 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
8016 },
8017 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
8018 # defined by the server.
8019 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
8020 # from the client to the backend for proxyless gRPC).
8021 # The possible values are:
8022 #
8023 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
8024 # backend service (Instance Group, Managed Instance Group, Network Endpoint
8025 # Group), regardless of traffic from the client to the proxy. Only IPv4
8026 # health checks are used to check the health of the backends. This is the
8027 # default setting.
8028 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
8029 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
8030 # address).
8031 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
8032 # backend service (Instance Group, Managed Instance Group, Network Endpoint
8033 # Group), regardless of traffic from the client to the proxy. Only IPv6
8034 # health checks are used to check the health of the backends.
8035 #
8036 #
8037 #
8038 # This field is applicable to either:
8039 #
8040 # - Advanced global external Application Load Balancer (load balancing
8041 # scheme EXTERNAL_MANAGED),
8042 # - Regional external Application Load
8043 # Balancer,
8044 # - Internal proxy Network Load Balancer (load balancing
8045 # scheme INTERNAL_MANAGED),
8046 # - Regional internal Application Load
8047 # Balancer (load balancing scheme INTERNAL_MANAGED),
8048 # - Traffic
8049 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
8050 # INTERNAL_SELF_MANAGED).
8051 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
8052 # for backend services.
8053 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
8054 # created for one type of load balancer cannot be used with another.
8055 # For more information, refer toChoosing
8056 # a load balancer.
8057 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
8058 # preference. When you use localityLbPolicies, you must set at least one
8059 # value for either the localityLbPolicies[].policy or the
8060 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
8061 # value set in the localityLbPolicy field.
8062 #
8063 # For an example of how to use this field, seeDefine
8064 # a list of preferred policies.
8065 #
8066 # Caution: This field and its children are intended for use in a service mesh
8067 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
8068 # that have this configuration.
8069 { # Container for either a built-in LB policy supported by gRPC or Envoy or
8070 # a custom one implemented by the end user.
8071 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
8072 # deployed with the client.
8073 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
8074 # by a locally installed custom policy implementation.
8075 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
8076 #
8077 # The value should match the name of a custom implementation registered
8078 # on the gRPC clients. It should follow protocol buffer message naming
8079 # conventions and include the full path (for example,
8080 # myorg.CustomLbPolicy). The maximum length is 256 characters.
8081 #
8082 # Do not specify the same custom policy more than once for a
8083 # backend. If you do, the configuration is rejected.
8084 #
8085 # For an example of how to use this field, seeUse
8086 # a custom policy.
8087 },
8088 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
8089 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
8090 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
8091 # about these values, see the description of localityLbPolicy.
8092 #
8093 # Do not specify the same policy more than once for a
8094 # backend. If you do, the configuration is rejected.
8095 },
8096 },
8097 ],
8098 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
8099 # possible values are:
8100 #
8101 # - ROUND_ROBIN: This is a simple policy in which each healthy
8102 # backend is selected in round robin order. This is the default.
8103 # - LEAST_REQUEST: An O(1) algorithm which
8104 # selects two random healthy hosts and picks the host which has fewer active
8105 # requests.
8106 # - RING_HASH: The ring/modulo hash load balancer implements
8107 # consistent hashing to backends. The algorithm has the property that the
8108 # addition/removal of a host from a set of N hosts only affects 1/N of the
8109 # requests.
8110 # - RANDOM: The load balancer selects a random healthy
8111 # host.
8112 # - ORIGINAL_DESTINATION: Backend host is selected
8113 # based on the client connection metadata, i.e., connections are opened to
8114 # the same address as the destination address of the incoming connection
8115 # before the connection was redirected to the load balancer.
8116 # - MAGLEV: used as a drop in replacement for the ring hash
8117 # load balancer. Maglev is not as stable as ring hash but has faster table
8118 # lookup build times and host selection times. For more information about
8119 # Maglev, see Maglev:
8120 # A Fast and Reliable Software Network Load Balancer.
8121 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
8122 # Load Balancing using weights computed from Backend reported Custom Metrics.
8123 # If set, the Backend Service responses are expected to contain non-standard
8124 # HTTP response header field Endpoint-Load-Metrics. The reported
8125 # metrics to use for computing the weights are specified via thecustomMetrics field.
8126 #
8127 # This field is applicable to either:
8128 # - A regional backend service with the service protocol set to HTTP,
8129 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
8130 # INTERNAL_MANAGED.
8131 # - A global backend service with the
8132 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
8133 # EXTERNAL_MANAGED.
8134 #
8135 #
8136 # If sessionAffinity is not configured—that is, if session
8137 # affinity remains at the default value of NONE—then the
8138 # default value for localityLbPolicy
8139 # is ROUND_ROBIN. If session affinity is set to a value other
8140 # than NONE,
8141 # then the default value for localityLbPolicy isMAGLEV.
8142 #
8143 # Only ROUND_ROBIN and RING_HASH are supported
8144 # when the backend service is referenced by a URL map that is bound to
8145 # target gRPC proxy that has validateForProxyless field set to true.
8146 #
8147 # localityLbPolicy cannot be specified with haPolicy.
8148 &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
8149 # by this backend service. If logging is enabled, logs will be exported to
8150 # Stackdriver.
8151 # backend service.
8152 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
8153 # traffic served by this backend service. The default value is false.
8154 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
8155 { # Determines which HTTP headers will be logged to Stackdriver.
8156 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
8157 },
8158 ],
8159 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
8160 { # Determines which HTTP headers will be logged to Stackdriver.
8161 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
8162 },
8163 ],
8164 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
8165 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
8166 # of optional fields you want to include in the logs. For example:
8167 # serverInstance, serverGkeDetails.cluster,
8168 # serverGkeDetails.pod.podNamespace
8169 &quot;A String&quot;,
8170 ],
8171 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
8172 # service. Configures whether all, none or a subset of optional fields
8173 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
8174 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
8175 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
8176 # service. The value of the field must be in [0, 1]. This configures the
8177 # sampling rate of requests to the load balancer where 1.0 means all logged
8178 # requests are reported and 0.0 means no logged requests are reported. The
8179 # default value is 1.0.
8180 },
8181 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
8182 # service. Duration is computed from the beginning of the stream until the
8183 # response has been completely processed, including all retries. A stream
8184 # that does not complete in this duration is closed.
8185 #
8186 # If not specified, there will be no timeout limit, i.e. the maximum
8187 # duration is infinite.
8188 #
8189 # This value can be overridden in the PathMatcher configuration of the
8190 # UrlMap that references this backend service.
8191 #
8192 # This field is only allowed when the loadBalancingScheme of
8193 # the backend service is INTERNAL_SELF_MANAGED.
8194 # as a count of seconds and fractions of seconds at nanosecond
8195 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
8196 # or &quot;month&quot;. Range is approximately 10,000 years.
8197 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
8198 # Durations less than one second are represented with a 0
8199 # `seconds` field and a positive `nanos` field. Must be from 0
8200 # to 999,999,999 inclusive.
8201 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
8202 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
8203 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
8204 },
8205 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
8206 # controller and read by the backend RCTH
8207 &quot;a_key&quot;: &quot;A String&quot;,
8208 },
8209 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
8210 # The name must be 1-63 characters long, and comply withRFC1035.
8211 # Specifically, the name must be 1-63 characters long and match the regular
8212 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
8213 # character must be a lowercase letter, and all following characters must
8214 # be a dash, lowercase letter, or digit, except the last character, which
8215 # cannot be a dash.
8216 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
8217 #
8218 # This field must be set for Internal Passthrough Network Load Balancers when
8219 # the haPolicy is enabled, and for External Passthrough Network Load
8220 # Balancers when the haPolicy fastIpMove is enabled.
8221 #
8222 # 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.
8223 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
8224 # Load Balancers.
8225 #
8226 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
8227 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
8228 # endpoints in the local zone.
8229 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
8230 # possible values are:
8231 #
8232 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
8233 # is disabled. The load balancer distributes new connections to all
8234 # healthy backend endpoints across all zones.
8235 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
8236 # enabled. The load balancer distributes new connections to all healthy
8237 # backend endpoints in the local zone only. If there are no healthy
8238 # backend endpoints in the local zone, the load balancer distributes
8239 # new connections to all backend endpoints in the local zone.
8240 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
8241 # enabled. The load balancer distributes new connections to all healthy
8242 # backend endpoints in the local zone only. If there aren&#x27;t enough
8243 # healthy backend endpoints in the local zone, the load balancer
8244 # distributes new connections to all healthy backend endpoints across all
8245 # zones.
8246 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
8247 # of healthy backend endpoints in a zone to the count of backend
8248 # endpoints in that same zone is equal to or above this threshold, the
8249 # load balancer distributes new connections to all healthy endpoints in
8250 # the local zone only. When the ratio of the count of healthy backend
8251 # endpoints in a zone to the count of backend endpoints in that same
8252 # zone is below this threshold, the load balancer distributes all new
8253 # connections to all healthy endpoints across all zones.
8254 },
8255 },
8256 &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.
8257 # the backend service.
8258 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
8259 # service.
8260 },
8261 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
8262 # load balancing pool of each individual proxy instance that processes the
8263 # traffic for the given backend service. If not set, this feature is
8264 # considered disabled.
8265 #
8266 # Results of the outlier detection algorithm (ejection of endpoints from the
8267 # load balancing pool and returning them back to the pool) are executed
8268 # independently by each proxy instance of the load balancer. In most cases,
8269 # more than one proxy instance handles the traffic received by a backend
8270 # service. Thus, it is possible that an unhealthy endpoint is detected and
8271 # ejected by only some of the proxies, and while this happens, other proxies
8272 # may continue to send requests to the same unhealthy endpoint until they
8273 # detect and eject the unhealthy endpoint.
8274 #
8275 # Applicable backend endpoints can be:
8276 #
8277 # - VM instances in an Instance Group
8278 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
8279 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
8280 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
8281 # Functions Services
8282 # - Private Service Connect NEGs, that resolve to
8283 # Google-managed regional API endpoints or managed services published using
8284 # Private Service Connect
8285 #
8286 #
8287 #
8288 # Applicable backend service types can be:
8289 #
8290 # - A global backend service with the loadBalancingScheme set to
8291 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
8292 # - A regional backend
8293 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
8294 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
8295 # supported for Serverless NEGs.
8296 #
8297 #
8298 #
8299 # Not supported when the backend service is referenced by a URL map that is
8300 # bound to target gRPC proxy that has validateForProxyless field set to true.
8301 # pool for the backend service.
8302 &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
8303 # or 30s.
8304 #
8305 # After a backend endpoint is returned back to the load balancing pool, it
8306 # can be ejected again in another ejection analysis. Thus, the total ejection
8307 # time is equal to the base ejection time multiplied by the number of times
8308 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
8309 # as a count of seconds and fractions of seconds at nanosecond
8310 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
8311 # or &quot;month&quot;. Range is approximately 10,000 years.
8312 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
8313 # Durations less than one second are represented with a 0
8314 # `seconds` field and a positive `nanos` field. Must be from 0
8315 # to 999,999,999 inclusive.
8316 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
8317 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
8318 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
8319 },
8320 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
8321 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
8322 # return code qualifies as an error. Defaults to 5.
8323 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
8324 # connection errors that are mapped to one of those status codes) before a
8325 # consecutive gateway failure ejection occurs. Defaults to 3.
8326 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
8327 # outlier status is detected through consecutive 5xx. This setting can be
8328 # used to disable ejection or to ramp it up slowly. Defaults to 0.
8329 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
8330 # outlier status is detected through consecutive gateway failures. This
8331 # setting can be used to disable ejection or to ramp it up slowly. Defaults
8332 # to 100.
8333 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
8334 # outlier status is detected through success rate statistics. This setting
8335 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
8336 #
8337 # Not supported when the backend service uses Serverless NEG.
8338 &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
8339 # ejections and backend endpoints being returned to service. The interval is
8340 # equal to the number of seconds as defined in
8341 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
8342 # in outlierDetection.interval.nanos. Defaults to 1 second.
8343 # as a count of seconds and fractions of seconds at nanosecond
8344 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
8345 # or &quot;month&quot;. Range is approximately 10,000 years.
8346 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
8347 # Durations less than one second are represented with a 0
8348 # `seconds` field and a positive `nanos` field. Must be from 0
8349 # to 999,999,999 inclusive.
8350 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
8351 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
8352 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
8353 },
8354 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
8355 # backend service that can be ejected if the ejection conditions are met.
8356 # Defaults to 50%.
8357 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
8358 # enough request volume to detect success rate outliers. If the number of
8359 # backend endpoints is fewer than this setting, outlier detection via success
8360 # rate statistics is not performed for any backend endpoint in the load
8361 # balancing pool. Defaults to 5.
8362 #
8363 # Not supported when the backend service uses Serverless NEG.
8364 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
8365 # (as defined by the interval duration above) to include this backend
8366 # endpoint in success rate based outlier detection. If the volume is lower
8367 # than this setting, outlier detection via success rate statistics is not
8368 # performed for that backend endpoint. Defaults to 100.
8369 #
8370 # Not supported when the backend service uses Serverless NEG.
8371 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
8372 # outlier ejection. The ejection threshold is the difference between the mean
8373 # success rate, and the product of this factor and the standard deviation of
8374 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
8375 # is divided by a thousand to get a double. That is, if the desired factor
8376 # is 1.9, the runtime value should be 1900. Defaults to 1900.
8377 #
8378 # Not supported when the backend service uses Serverless NEG.
8379 },
8380 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
8381 # as part of resource payload.
8382 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
8383 # Tag keys and values have the same definition as resource
8384 # manager tags. The field is allowed for INSERT
8385 # only. The keys/values to set on the resource should be specified in
8386 # either ID { : } or Namespaced format
8387 # { : }.
8388 # For example the following are valid inputs:
8389 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
8390 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
8391 # Note:
8392 # * Invalid combinations of ID &amp; namespaced format is not supported. For
8393 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
8394 &quot;a_key&quot;: &quot;A String&quot;,
8395 },
8396 },
8397 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
8398 # the backend. The default value is 80.
8399 # For internal passthrough Network Load Balancers and external passthrough
8400 # Network Load Balancers, omit port.
8401 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
8402 # communication to the backend VMs in that group. The
8403 # named port must be [defined on each backend instance
8404 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
8405 # This parameter has no meaning if the backends are NEGs. For internal
8406 # passthrough Network Load Balancers and external passthrough Network Load
8407 # Balancers, omit port_name.
8408 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
8409 # with backends.
8410 #
8411 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
8412 # depending on the chosen load balancer or Traffic Director configuration.
8413 # Refer to the documentation for the load balancers or for Traffic Director
8414 # for more information.
8415 #
8416 # Must be set to GRPC when the backend service is referenced by a URL map
8417 # that is bound to target gRPC proxy.
8418 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
8419 # resides. This field is not applicable to global backend services.
8420 # You must specify this field as part of the HTTP request URL. It is
8421 # not settable as a field in the request body.
8422 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
8423 # backend service.
8424 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
8425 # service. This field is applicable to a global backend service with the
8426 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
8427 &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
8428 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
8429 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
8430 # private storage buckets that support Signature Version 4 for authentication.
8431 # The service name for generating the authentication header will always default
8432 # to &#x27;s3&#x27;.
8433 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
8434 # creating a backend that uses AWS v4 signature authentication, but will not
8435 # be returned as part of the configuration when queried with a REST API GET
8436 # request.
8437 #
8438 # @InputOnly
8439 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
8440 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
8441 # keep track of different iterations of your access key.
8442 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
8443 # the name of the region your cloud uses to host your origin. For example,
8444 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
8445 },
8446 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
8447 # that describes how clients should authenticate with this service&#x27;s
8448 # backends.
8449 #
8450 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
8451 # to INTERNAL_SELF_MANAGED.
8452 #
8453 # If left blank, communications are not encrypted.
8454 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
8455 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
8456 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
8457 # specified values, the communication continues. Otherwise, it fails. This
8458 # additional check enables the client to verify that the server is authorized
8459 # to run the requested service.
8460 #
8461 # Note that the contents of the server
8462 # certificate&#x27;s subjectAltName field are configured by the
8463 # Public Key Infrastructure which provisions server identities.
8464 #
8465 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
8466 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
8467 # mode).
8468 &quot;A String&quot;,
8469 ],
8470 },
8471 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
8472 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
8473 #
8474 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
8475 # If set, lists of backends and health checks must be both empty.
8476 &quot;A String&quot;,
8477 ],
8478 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
8479 #
8480 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
8481 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
8482 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
8483 #
8484 # Only NONE and HEADER_FIELD are supported
8485 # when the backend service is referenced by a URL map that is bound to
8486 # target gRPC proxy that has validateForProxyless field set to true.
8487 #
8488 # For more details, see:
8489 # [Session
8490 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
8491 #
8492 # sessionAffinity cannot be specified with haPolicy.
8493 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
8494 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
8495 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
8496 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
8497 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
8498 # as a count of seconds and fractions of seconds at nanosecond
8499 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
8500 # or &quot;month&quot;. Range is approximately 10,000 years.
8501 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
8502 # Durations less than one second are represented with a 0
8503 # `seconds` field and a positive `nanos` field. Must be from 0
8504 # to 999,999,999 inclusive.
8505 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
8506 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
8507 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
8508 },
8509 },
8510 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
8511 # Currently this is applicable only for Internal TCP/UDP load balancing,
8512 # Internal HTTP(S) load balancing and Traffic Director.
8513 &quot;policy&quot;: &quot;A String&quot;,
8514 },
8515 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
8516 # type of load balancer. For more information see,
8517 # Backend service settings.
8518 # The default is 30 seconds.
8519 # The full range of timeout values allowed goes from 1
8520 # through 2,147,483,647 seconds.
8521 #
8522 # This value can be overridden in the PathMatcher configuration of the
8523 # UrlMap that references this backend service.
8524 #
8525 # Not supported when the backend service is referenced by a URL map that is
8526 # bound to target gRPC proxy that has validateForProxyless field set to true.
8527 # Instead, use maxStreamDuration.
8528 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
8529 # when the backend protocol is SSL, HTTPS or HTTP2.
8530 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
8531 # networksecurity.googleapis.com namespace. Can be used in authenticating
8532 # TLS connections to the backend, as specified by the authenticationMode
8533 # field. Can only be specified if authenticationMode is not NONE.
8534 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
8535 # balancer sends this string as the SNI hostname in the TLS connection to
8536 # the backend, and requires that this string match a Subject Alternative
8537 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
8538 # NEG backend, if the SNI is specified here, the load balancer uses it
8539 # regardless of whether the Regional Internet NEG is specified with FQDN or
8540 # IP address and port. When both sni and subjectAltNames[] are specified,
8541 # the load balancer matches the backend certificate&#x27;s SAN only to
8542 # subjectAltNames[].
8543 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
8544 # verifies during a TLS handshake with the backend. When the server
8545 # presents its X.509 certificate to the Load Balancer, the Load Balancer
8546 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
8547 # match one of the subjectAltNames in the list. This field is limited to 5
8548 # entries. When both sni and subjectAltNames[] are specified, the load
8549 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
8550 { # A Subject Alternative Name that the load balancer matches against the SAN
8551 # field in the TLS certificate provided by the backend, specified as either
8552 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
8553 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
8554 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
8555 },
8556 ],
8557 },
8558 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
8559 {
8560 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
8561 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
8562 # and ForwardingRule.
8563 },
8564 ],
8565 },
8566 ],
8567 &quot;kind&quot;: &quot;compute#usableBackendServiceList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#usableBackendServiceList for lists of usable backend
8568 # services.
8569 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
8570 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
8571 # the query parameter pageToken in the next list request.
8572 # Subsequent list requests will have their own nextPageToken to
8573 # continue paging through the results.
8574 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
8575 &quot;warning&quot;: { # [Output Only] Informational warning message.
8576 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
8577 # Engine returns NO_RESULTS_ON_PAGE if there
8578 # are no results in the response.
8579 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
8580 # value format. For example:
8581 #
8582 # &quot;data&quot;: [
8583 # {
8584 # &quot;key&quot;: &quot;scope&quot;,
8585 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
8586 # }
8587 {
8588 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
8589 # returned. For example, for warnings where there are no results in a list
8590 # request for a particular zone, this key might be scope and
8591 # the key value might be the zone name. Other examples might be a key
8592 # indicating a deprecated resource and a suggested replacement, or a
8593 # warning about invalid network settings (for example, if an instance
8594 # attempts to perform IP forwarding but is not enabled for IP forwarding).
8595 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
8596 },
8597 ],
8598 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
8599 },
8600 }</pre>
8601 </div>
8602
8603 <div class="method">
8604 <code class="details" id="listUsable_next">listUsable_next()</code>
8605 <pre>Retrieves the next page of results.
8606
8607 Args:
8608 previous_request: The request for the previous page. (required)
8609 previous_response: The response from the request for the previous page. (required)
8610
8611 Returns:
8612 A request object that you can call &#x27;execute()&#x27; on to request the next
8613 page. Returns None if there are no more items in the collection.
8614 </pre>
8615 </div>
8616
8617 <div class="method">
8618 <code class="details" id="list_next">list_next()</code>
8619 <pre>Retrieves the next page of results.
8620
8621 Args:
8622 previous_request: The request for the previous page. (required)
8623 previous_response: The response from the request for the previous page. (required)
8624
8625 Returns:
8626 A request object that you can call &#x27;execute()&#x27; on to request the next
8627 page. Returns None if there are no more items in the collection.
8628 </pre>
8629 </div>
8630
8631 <div class="method">
8632 <code class="details" id="patch">patch(project, backendService, body=None, requestId=None, x__xgafv=None)</code>
8633 <pre>Patches the specified BackendService resource with the data included in the
8634 request. For more information, see
8635 Backend services overview. This method
8636 supports PATCH semantics and uses the JSON merge
8637 patch format and processing rules.
8638
8639 Args:
8640 project: string, Project ID for this request. (required)
8641 backendService: string, Name of the BackendService resource to patch. (required)
8642 body: object, The request body.
8643 The object takes the form of:
8644
8645 { # Represents a Backend Service resource.
8646 #
8647 # A backend service defines how Google Cloud load balancers distribute traffic.
8648 # The backend service configuration contains a set of values, such as the
8649 # protocol used to connect to backends, various distribution and session
8650 # settings, health checks, and timeouts. These settings provide fine-grained
8651 # control over how your load balancer behaves. Most of the settings have
8652 # default values that allow for easy configuration if you need to get started
8653 # quickly.
8654 #
8655 # Backend services in Google Compute Engine can be either regionally or
8656 # globally scoped.
8657 #
8658 # * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices)
8659 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices)
8660 #
8661 # For more information, seeBackend
8662 # Services.
8663 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
8664 # Load Balancers and Traffic Director and requires
8665 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
8666 #
8667 # If set to 0, the cookie is non-persistent and lasts only until
8668 # the end of the browser session (or equivalent). The maximum allowed value
8669 # is two weeks (1,209,600).
8670 #
8671 # Not supported when the backend service is referenced by a URL map that is
8672 # bound to target gRPC proxy that has validateForProxyless field set to true.
8673 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
8674 { # Message containing information of one individual backend.
8675 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
8676 # handle additional traffic or is fully loaded. For usage guidelines, see
8677 # Connection balancing mode.
8678 #
8679 # Backends must use compatible balancing modes. For more information, see
8680 # Supported balancing modes and target capacity settings and
8681 # Restrictions and guidance for instance groups.
8682 #
8683 # Note: Currently, if you use the API to configure incompatible balancing
8684 # modes, the configuration might be accepted even though it has no impact
8685 # and is ignored. Specifically, Backend.maxUtilization is ignored when
8686 # Backend.balancingMode is RATE. In the future, this incompatible combination
8687 # will be rejected.
8688 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
8689 # mode.
8690 # The default value is 1, which means the group serves up to
8691 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
8692 # completely drained, offering 0% of its available capacity. The valid ranges
8693 # are 0.0 and [0.1,1.0].
8694 # You cannot configure a setting larger than 0 and smaller than0.1.
8695 # You cannot configure a setting of 0 when there is only one
8696 # backend attached to the backend service.
8697 #
8698 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
8699 # internet NEGs, regional serverless NEGs, and PSC NEGs.
8700 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
8701 # BalancingMode.
8702 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
8703 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
8704 # Monitoring, but is not used for load balancing.
8705 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
8706 # balancing mode. The valid range is [0.0, 1.0].
8707 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
8708 # long and match the regular expression
8709 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
8710 # first character must be a lowercase letter, and all following
8711 # characters must be a dash, period, underscore, lowercase letter, or
8712 # digit, except the last character, which cannot be a dash, period, or
8713 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
8714 # field can only be used for a global or regional backend service with the
8715 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
8716 },
8717 ],
8718 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
8719 # create the resource.
8720 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
8721 # failover backend can be configured for a given BackendService.
8722 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
8723 # group or network endpoint
8724 # group (NEG) resource. To determine what types of backends a load
8725 # balancer supports, see the [Backend services
8726 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
8727 #
8728 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
8729 # or NEG. Partial URLs are not supported.
8730 #
8731 # If haPolicy is specified, backends must refer to NEG resources of type
8732 # GCE_VM_IP.
8733 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
8734 # guidelines, seeConnection
8735 # balancing mode and Utilization
8736 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
8737 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
8738 # guidelines, seeConnection
8739 # balancing mode and Utilization
8740 # balancing mode.
8741 #
8742 # Not available if the backend&#x27;s balancingMode isRATE.
8743 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
8744 # For usage guidelines, seeConnection
8745 # balancing mode and Utilization
8746 # balancing mode.
8747 #
8748 # Not available if the backend&#x27;s balancingMode isRATE.
8749 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
8750 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
8751 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
8752 # Not available if backend&#x27;s balancingMode is RATE
8753 # or CONNECTION.
8754 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
8755 # Not available if backend&#x27;s balancingMode is RATE
8756 # or CONNECTION.
8757 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
8758 # usage guidelines, seeRate
8759 # balancing mode and Utilization
8760 # balancing mode.
8761 #
8762 # Not available if the backend&#x27;s balancingMode isCONNECTION.
8763 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
8764 # guidelines, seeRate
8765 # balancing mode and Utilization
8766 # balancing mode.
8767 #
8768 # Not available if the backend&#x27;s balancingMode isCONNECTION.
8769 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
8770 # guidelines, seeRate
8771 # balancing mode and Utilization
8772 # balancing mode.
8773 #
8774 # Not available if the backend&#x27;s balancingMode isCONNECTION.
8775 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
8776 #
8777 # For usage guidelines, seeUtilization
8778 # balancing mode.
8779 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
8780 # the backend.
8781 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
8782 },
8783 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
8784 # sending traffic to backends with default preference. The possible values
8785 # are:
8786 #
8787 # - PREFERRED: Backends with this preference level will be
8788 # filled up to their capacity limits first, based on RTT.
8789 # - DEFAULT: If preferred backends don&#x27;t have enough
8790 # capacity, backends in this layer would be used and traffic would be
8791 # assigned based on the load balancing algorithm you use. This is the
8792 # default
8793 &quot;trafficDuration&quot;: &quot;A String&quot;,
8794 },
8795 ],
8796 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
8797 # specified load balancer types.
8798 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
8799 # Pragma or Authorization headers. Up to 5 headers can be specified.
8800 # The cache is bypassed for all cdnPolicy.cacheMode settings.
8801 { # Bypass the cache when the specified request headers are present,
8802 # e.g. Pragma or Authorization headers. Values are case insensitive.
8803 # The presence of such a header overrides the cache_mode setting.
8804 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
8805 # Values are case-insensitive.
8806 },
8807 ],
8808 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
8809 # CDN.
8810 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
8811 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
8812 &quot;A String&quot;,
8813 ],
8814 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
8815 # The name=value pair will be used in the cache key Cloud CDN generates.
8816 &quot;A String&quot;,
8817 ],
8818 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
8819 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
8820 # query_string_whitelist and query_string_blacklist. If neither is set, the
8821 # entire query string will be included. If false, the query string will be
8822 # excluded from the cache key entirely.
8823 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
8824 # parameters will be included. Either specify query_string_whitelist or
8825 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
8826 # not treated as delimiters.
8827 &quot;A String&quot;,
8828 ],
8829 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
8830 # parameters will be excluded. Either specify query_string_whitelist or
8831 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
8832 # not treated as delimiters.
8833 &quot;A String&quot;,
8834 ],
8835 },
8836 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
8837 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
8838 # headers to cache content. Responses without these headers will not be
8839 # cached at Google&#x27;s edge, and will require a full trip to the origin on
8840 # every request, potentially impacting performance and increasing load on
8841 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
8842 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
8843 # Warning: this may result in Cloud CDN caching private,
8844 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
8845 # including common image formats, media (video and audio), and web assets
8846 # (JavaScript and CSS). Requests and responses that are marked as
8847 # uncacheable, as well as dynamic content (including HTML), will not be
8848 # cached.
8849 #
8850 # If no value is provided for cdnPolicy.cacheMode, it defaults
8851 # to CACHE_ALL_STATIC.
8852 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
8853 # used to clamp the max-age (or Expires) value sent to the client. With
8854 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
8855 # response max-age directive, along with a &quot;public&quot; directive. For
8856 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
8857 # from the origin (if specified), or else sets the response max-age
8858 # directive to the lesser of the client_ttl and default_ttl, and also
8859 # ensures a &quot;public&quot; cache-control directive is present.
8860 # If a client TTL is not specified, a default value (1 hour) will be used.
8861 # The maximum allowed value is 31,622,400s (1 year).
8862 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
8863 # responses that do not have an existing valid TTL (max-age or s-maxage).
8864 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
8865 # The value of defaultTTL cannot be set to a value greater than that of
8866 # maxTTL, but can be equal.
8867 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
8868 # will overwrite the TTL set in all responses. The maximum allowed value is
8869 # 31,622,400s (1 year), noting that infrequently accessed objects may be
8870 # evicted from the cache before the defined TTL.
8871 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
8872 # origin.
8873 # Cache directives that attempt to set a max-age or s-maxage higher than
8874 # this, or an Expires header more than maxTTL seconds in the future will
8875 # be capped at the value of maxTTL, as if it were the value of an
8876 # s-maxage Cache-Control directive.
8877 # Headers sent to the client will not be modified.
8878 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
8879 # The maximum allowed value is 31,622,400s (1 year), noting that
8880 # infrequently accessed objects may be evicted from the cache before
8881 # the defined TTL.
8882 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
8883 # to apply fine-grained caching for common errors or redirects.
8884 # This can reduce the load on your origin and improve end-user
8885 # experience by reducing response latency.
8886 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
8887 # negative caching applies to responses with the specified response code
8888 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
8889 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
8890 # to all responses with the specified response code, and override any
8891 # caching headers.
8892 # By default, Cloud CDN will apply the following default TTLs to these
8893 # status codes:
8894 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
8895 # HTTP 404 (Not Found), 410 (Gone),
8896 # 451 (Unavailable For Legal Reasons): 120s
8897 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
8898 # These defaults can be overridden in negative_caching_policy.
8899 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
8900 # negative_caching must be enabled to configure negative_caching_policy.
8901 # Omitting the policy and leaving negative_caching enabled will use
8902 # Cloud CDN&#x27;s default cache TTLs.
8903 # Note that when specifying an explicit negative_caching_policy, you
8904 # should take care to specify a cache TTL for all response codes
8905 # that you wish to cache. Cloud CDN will not apply any default
8906 # negative caching when a policy exists.
8907 { # Specify CDN TTLs for response error codes.
8908 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
8909 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
8910 # specified as values, and you cannot specify a status code more than
8911 # once.
8912 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
8913 # corresponding status code.
8914 # The maximum allowed value is 1800s (30 minutes), noting that
8915 # infrequently accessed objects may be evicted from the cache before the
8916 # defined TTL.
8917 },
8918 ],
8919 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
8920 # requests into a small number of requests to the origin.
8921 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
8922 # content with the origin, or when an error is encountered when refreshing
8923 # the cache.
8924 # This setting defines the default &quot;max-stale&quot; duration for any cached
8925 # responses that do not specify a max-stale directive. Stale responses that
8926 # exceed the TTL configured here will not be served. The default limit
8927 # (max-stale) is 86400s (1 day), which will allow stale content to be
8928 # served up to this limit beyond the max-age (or s-maxage) of a cached
8929 # response.
8930 # The maximum allowed value is 604800 (1 week).
8931 # Set this to zero (0) to disable serve-while-stale.
8932 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
8933 # considered fresh. After this time period, the response will be
8934 # revalidated before being served. Defaults to 1hr (3600s). When serving
8935 # responses to signed URL requests, Cloud CDN will internally behave as
8936 # though all responses from this backend had a &quot;Cache-Control:
8937 # public, max-age=[TTL]&quot; header, regardless of any existing
8938 # Cache-Control header. The actual headers served in responses will not be
8939 # altered.
8940 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
8941 &quot;A String&quot;,
8942 ],
8943 },
8944 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
8945 # backend service.
8946 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
8947 # there is no limit.
8948 #
8949 # Not supported when the backend service is referenced by a URL map that is
8950 # bound to target gRPC proxy that has validateForProxyless field set to true.
8951 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
8952 # not specified, there is no limit.
8953 #
8954 # Not supported when the backend service is referenced by a URL map that is
8955 # bound to target gRPC proxy that has validateForProxyless field set to true.
8956 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
8957 # service. If not specified, there is no limit.
8958 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
8959 # This parameter is respected by both the HTTP/1.1 and HTTP/2
8960 # implementations. If not specified, there is no limit. Setting this
8961 # parameter to 1 will effectively disable keep alive.
8962 #
8963 # Not supported when the backend service is referenced by a URL map that is
8964 # bound to target gRPC proxy that has validateForProxyless field set to true.
8965 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
8966 # not specified, the default is 1.
8967 #
8968 # Not supported when the backend service is referenced by a URL map that is
8969 # bound to target gRPC proxy that has validateForProxyless field set to true.
8970 },
8971 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
8972 # the client&#x27;s Accept-Encoding header.
8973 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
8974 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
8975 # instance. For supported load balancers and protocols, as described inEnabling
8976 # connection draining.
8977 },
8978 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
8979 # tracking policy settings are only available for external passthrough
8980 # Network Load Balancers and internal passthrough Network Load Balancers.
8981 #
8982 # connectionTrackingPolicy cannot be specified with haPolicy.
8983 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
8984 # value is DEFAULT_FOR_PROTOCOL.
8985 #
8986 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
8987 # persist on unhealthy backends only for connection-oriented protocols
8988 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
8989 # Affinity is configured for 5-tuple. They do not persist forUDP.
8990 #
8991 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
8992 # the existing connections on the unhealthy backend are never persisted on
8993 # the unhealthy backend. They are always diverted to newly selected healthy
8994 # backends (unless all backends are unhealthy).
8995 #
8996 # If set to ALWAYS_PERSIST, existing connections always
8997 # persist on unhealthy backends regardless of protocol and session
8998 # affinity. It is generally not recommended to use this mode overriding the
8999 # default.
9000 #
9001 # For more details, see [Connection Persistence for Network Load
9002 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
9003 # and [Connection Persistence for Internal TCP/UDP Load
9004 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
9005 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
9006 # Balancers. This option is not available publicly.
9007 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
9008 # matching traffic (in seconds).
9009 #
9010 # For internal passthrough Network Load Balancers:
9011 #
9012 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
9013 # - It can be set only if Connection Tracking is less than 5-tuple
9014 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
9015 # Mode is PER_SESSION).
9016 #
9017 #
9018 #
9019 # For external passthrough Network Load Balancers the default is 60
9020 # seconds. This option is not available publicly.
9021 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
9022 # options:
9023 #
9024 # - PER_CONNECTION: This is the default mode. The Connection
9025 # Tracking is performed as per the Connection Key (default Hash Method) for
9026 # the specific protocol.
9027 # - PER_SESSION: The Connection Tracking is performed as per
9028 # the configured Session Affinity. It matches the configured Session
9029 # Affinity.
9030 #
9031 #
9032 #
9033 # For more details, see [Tracking Mode for Network Load
9034 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
9035 # and [Tracking Mode for Internal TCP/UDP Load
9036 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
9037 },
9038 &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
9039 # affinity based on HTTP headers, cookies or other properties. This load
9040 # balancing policy is applicable only for HTTP connections. The affinity to a
9041 # particular destination host will be lost when one or more hosts are
9042 # added/removed from the destination service. This field specifies parameters
9043 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
9044 #
9045 # This field is applicable to either:
9046 #
9047 # - A regional backend service with the service protocol set to HTTP,
9048 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
9049 # INTERNAL_MANAGED.
9050 # - A global backend service with the
9051 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
9052 &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
9053 # be used as the hash key for the consistent hash load balancer. If the
9054 # cookie is not present, it will be generated. This field is applicable if
9055 # the sessionAffinity is set to HTTP_COOKIE.
9056 #
9057 # Not supported when the backend service is referenced by a URL map that is
9058 # bound to target gRPC proxy that has validateForProxyless field set to true.
9059 # for load balancing policies that use a consistent hash.
9060 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
9061 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
9062 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
9063 # as a count of seconds and fractions of seconds at nanosecond
9064 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
9065 # or &quot;month&quot;. Range is approximately 10,000 years.
9066 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
9067 # Durations less than one second are represented with a 0
9068 # `seconds` field and a positive `nanos` field. Must be from 0
9069 # to 999,999,999 inclusive.
9070 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
9071 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
9072 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
9073 },
9074 },
9075 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
9076 # applicable if the sessionAffinity is set toHEADER_FIELD.
9077 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
9078 # 1024. Larger ring sizes result in more granular load distributions. If the
9079 # number of hosts in the load balancing pool is larger than the ring size,
9080 # each host will be assigned a single virtual node.
9081 },
9082 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
9083 # text format.
9084 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
9085 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
9086 # locality_lb_policy.
9087 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
9088 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
9089 # long and match the regular expression
9090 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
9091 # first character must be a lowercase letter, and all following
9092 # characters must be a dash, period, underscore, lowercase letter, or
9093 # digit, except the last character, which cannot be a dash, period, or
9094 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
9095 # field can only be used for a global or regional backend service with the
9096 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
9097 },
9098 ],
9099 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
9100 # custom
9101 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
9102 &quot;A String&quot;,
9103 ],
9104 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
9105 # custom
9106 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
9107 &quot;A String&quot;,
9108 ],
9109 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
9110 # create the resource.
9111 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
9112 # this backend service.
9113 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
9114 # global external Application Load Balancer.
9115 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
9116 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
9117 #
9118 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
9119 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
9120 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
9121 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
9122 # externalManagedMigrationTestingPercentage.
9123 #
9124 # Rolling back a migration requires the states to be set in reverse order. So
9125 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
9126 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
9127 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
9128 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
9129 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
9130 # external Application Load Balancer.
9131 #
9132 # The value of this field must be in the range [0, 100].
9133 #
9134 # Session affinity options will slightly affect this routing behavior, for
9135 # more details, see:Session
9136 # Affinity.
9137 #
9138 # This value can only be set if the loadBalancingScheme in the BackendService
9139 # is set to EXTERNAL (when using the classic Application Load Balancer) and
9140 # the migration state is TEST_BY_PERCENTAGE.
9141 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
9142 # as a backup (failover) backend.
9143 # For load balancers that have configurable failover:
9144 # [Internal passthrough Network Load
9145 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
9146 # and [external passthrough Network Load
9147 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
9148 #
9149 # failoverPolicy cannot be specified with haPolicy.
9150 # failover:
9151 # [Internal passthrough Network Load
9152 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
9153 # and [external passthrough
9154 # Network Load
9155 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
9156 # On failover or failback, this field indicates whether connection draining
9157 # will be honored. Google Cloud has a fixed connection draining timeout of
9158 # 10 minutes. A setting of true terminates existing TCP
9159 # connections to the active pool during failover and failback, immediately
9160 # draining traffic. A setting of false allows existing TCP
9161 # connections to persist, even on VMs no longer in the active pool, for up
9162 # to the duration of the connection draining timeout (10 minutes).
9163 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
9164 #
9165 # The default is false.
9166 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
9167 # load balancer are dropped when all primary and all backup backend VMs are
9168 # unhealthy.If set to false, connections are distributed
9169 # among all primary VMs when all primary and all backup backend VMs are
9170 # unhealthy.
9171 # For load balancers that have configurable
9172 # failover:
9173 # [Internal passthrough
9174 # Network Load
9175 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
9176 # and [external passthrough
9177 # Network Load
9178 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
9179 # The default is false.
9180 &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
9181 # failover when the number of healthy primary VMs equals zero.
9182 # For all other values, the load balancer performs a failover when the
9183 # total number of healthy primary VMs is less than this ratio.
9184 # For load balancers that have configurable
9185 # failover:
9186 # [Internal TCP/UDP Load
9187 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
9188 # and [external TCP/UDP Load
9189 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
9190 },
9191 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
9192 # This field is used in optimistic locking. This field will be ignored when
9193 # inserting a BackendService. An up-to-date fingerprint must be provided in
9194 # order to update the BackendService, otherwise the request will
9195 # fail with error 412 conditionNotMet.
9196 #
9197 # To see the latest fingerprint, make a get() request to
9198 # retrieve a BackendService.
9199 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
9200 # Protocol Forwarding.
9201 #
9202 # The backends of this regional backend service must only specify zonal
9203 # network endpoint groups (NEGs) of type GCE_VM_IP.
9204 #
9205 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
9206 # regional backend service must set the network field. All zonal NEGs must
9207 # belong to the same network. However, individual NEGs can
9208 # belong to different subnetworks of that network.
9209 #
9210 # When haPolicy is specified, the set of attached network endpoints across
9211 # all backends comprise an High Availability domain from which one endpoint
9212 # is selected as the active endpoint (the leader) that receives all
9213 # traffic.
9214 #
9215 # haPolicy can be added only at backend service creation time. Once set up,
9216 # it cannot be deleted.
9217 #
9218 # Note that haPolicy is not for load balancing, and therefore cannot be
9219 # specified with sessionAffinity, connectionTrackingPolicy, and
9220 # failoverPolicy.
9221 #
9222 # haPolicy requires customers to be responsible for tracking backend
9223 # endpoint health and electing a leader among the healthy endpoints.
9224 # Therefore, haPolicy cannot be specified with healthChecks.
9225 #
9226 # haPolicy can only be specified for External Passthrough Network Load
9227 # Balancers and Internal Passthrough Network Load Balancers.
9228 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
9229 # achieve it.
9230 #
9231 # Supported values are:
9232 #
9233 # - DISABLED: Fast IP Move is disabled. You can only use the
9234 # haPolicy.leader API to update the leader.
9235 # - &gt;GARP_RA: Provides a method to very quickly define a new network
9236 # endpoint as the leader. This method is faster than updating the leader
9237 # using the haPolicy.leader API. Fast IP move works as follows: The VM
9238 # hosting the network endpoint that should become the new leader sends
9239 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
9240 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
9241 # temporarily associates the forwarding rule IP address with that VM, and
9242 # both new and in-flight packets are quickly delivered to that VM.
9243 #
9244 #
9245 #
9246 # Note the important properties of the Fast IP Move functionality:
9247 #
9248 # - The GARP/RA-initiated re-routing stays active for approximately 20
9249 # minutes. After triggering fast failover, you must also
9250 # appropriately set the haPolicy.leader.
9251 # - The new leader instance should continue to send GARP/RA packets
9252 # periodically every 10 seconds until at least 10 minutes after updating
9253 # the haPolicy.leader (but stop immediately if it is no longer the leader).
9254 # - After triggering a fast failover, we recommend that you wait at least
9255 # 3 seconds before sending another GARP/RA packet from a different VM
9256 # instance to avoid race conditions.
9257 # - Don&#x27;t send GARP/RA packets from different VM
9258 # instances at the same time. If multiple instances continue to send
9259 # GARP/RA packets, traffic might be routed to different destinations in an
9260 # alternating order. This condition ceases when a single instance
9261 # issues a GARP/RA packet.
9262 # - The GARP/RA request always takes priority over the leader API.
9263 # Using the haPolicy.leader API to change the leader to a different
9264 # instance will have no effect until the GARP/RA request becomes
9265 # inactive.
9266 # - The GARP/RA packets should follow the GARP/RA
9267 # Packet Specifications..
9268 # - When multiple forwarding rules refer to a regional backend service,
9269 # you need only send a GARP or RA packet for a single forwarding rule
9270 # virtual IP. The virtual IPs for all forwarding rules targeting the same
9271 # backend service will also be moved to the sender of the GARP or RA
9272 # packet.
9273 #
9274 #
9275 #
9276 # The following are the Fast IP Move limitations (that is, when fastIPMove
9277 # is not DISABLED):
9278 #
9279 # - Multiple forwarding rules cannot use the same IP address if one of
9280 # them refers to a regional backend service with fastIPMove.
9281 # - The regional backend service must set the network field, and all
9282 # NEGs must belong to that network. However, individual
9283 # NEGs can belong to different subnetworks of that network.
9284 # - The maximum number of network endpoints across all backends of a
9285 # backend service with fastIPMove is 32.
9286 # - The maximum number of backend services with fastIPMove that can have
9287 # the same network endpoint attached to one of its backends is 64.
9288 # - The maximum number of backend services with fastIPMove in a VPC in a
9289 # region is 64.
9290 # - The network endpoints that are attached to a backend of a backend
9291 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
9292 # - Traffic directed to the leader by a static route next hop will not be
9293 # redirected to a new leader by fast failover. Such traffic will only be
9294 # redirected once an haPolicy.leader update has taken effect. Only traffic
9295 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
9296 # fast failover.
9297 #
9298 #
9299 # haPolicy.fastIPMove can be set only at backend service creation time.
9300 # Once set, it cannot be updated.
9301 #
9302 # By default, fastIpMove is set to DISABLED.
9303 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
9304 # this service as the active endpoint (the leader) that receives all
9305 # traffic.
9306 #
9307 # When the leader changes, there is no connection draining to persist
9308 # existing connections on the old leader.
9309 #
9310 # You are responsible for selecting a suitable endpoint as the
9311 # leader. For example, preferring a healthy endpoint over unhealthy ones.
9312 # Note that this service does not track backend endpoint health, and
9313 # selects the configured leader unconditionally.
9314 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
9315 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
9316 # that the leader is attached to.
9317 #
9318 # The leader&#x27;s backendGroup must already be specified as a backend of
9319 # this backend service. Removing a backend that is designated as the
9320 # leader&#x27;s backendGroup is not permitted.
9321 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
9322 # designated as the leader.
9323 #
9324 # This network endpoint cannot be detached from the NEG specified in
9325 # the haPolicy.leader.backendGroup until the leader is updated with
9326 # another network endpoint, or the leader is removed from the haPolicy.
9327 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
9328 # instance must already be attached to the NEG specified in the
9329 # haPolicy.leader.backendGroup.
9330 #
9331 # The name must be 1-63 characters long, and comply with RFC1035.
9332 # Authorization requires the following IAM permission on the
9333 # specified resource instance: compute.instances.use
9334 },
9335 },
9336 },
9337 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
9338 # httpsHealthChecks (legacy) resource for health checking this backend
9339 # service. Not all backend services support legacy health checks. See
9340 # Load balancer guide. Currently, at most one health check can be
9341 # specified for each backend service. Backend services with
9342 # instance group or zonal NEG backends must have a health check unless
9343 # haPolicy is specified. Backend services with internet or serverless NEG
9344 # backends must not have a health check.
9345 #
9346 # healthChecks[] cannot be specified with haPolicy.
9347 &quot;A String&quot;,
9348 ],
9349 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
9350 # Not available for internal passthrough Network Load Balancers and external
9351 # passthrough Network Load Balancers.
9352 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
9353 # incoming requests.
9354 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
9355 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
9356 # For security reasons, this value cannot be retrieved via the API.
9357 # Instead, the SHA-256 hash of the value is returned in the
9358 # oauth2ClientSecretSha256 field.
9359 #
9360 # @InputOnly
9361 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
9362 },
9363 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
9364 # defined by the server.
9365 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
9366 # from the client to the backend for proxyless gRPC).
9367 # The possible values are:
9368 #
9369 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
9370 # backend service (Instance Group, Managed Instance Group, Network Endpoint
9371 # Group), regardless of traffic from the client to the proxy. Only IPv4
9372 # health checks are used to check the health of the backends. This is the
9373 # default setting.
9374 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
9375 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
9376 # address).
9377 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
9378 # backend service (Instance Group, Managed Instance Group, Network Endpoint
9379 # Group), regardless of traffic from the client to the proxy. Only IPv6
9380 # health checks are used to check the health of the backends.
9381 #
9382 #
9383 #
9384 # This field is applicable to either:
9385 #
9386 # - Advanced global external Application Load Balancer (load balancing
9387 # scheme EXTERNAL_MANAGED),
9388 # - Regional external Application Load
9389 # Balancer,
9390 # - Internal proxy Network Load Balancer (load balancing
9391 # scheme INTERNAL_MANAGED),
9392 # - Regional internal Application Load
9393 # Balancer (load balancing scheme INTERNAL_MANAGED),
9394 # - Traffic
9395 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
9396 # INTERNAL_SELF_MANAGED).
9397 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
9398 # for backend services.
9399 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
9400 # created for one type of load balancer cannot be used with another.
9401 # For more information, refer toChoosing
9402 # a load balancer.
9403 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
9404 # preference. When you use localityLbPolicies, you must set at least one
9405 # value for either the localityLbPolicies[].policy or the
9406 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
9407 # value set in the localityLbPolicy field.
9408 #
9409 # For an example of how to use this field, seeDefine
9410 # a list of preferred policies.
9411 #
9412 # Caution: This field and its children are intended for use in a service mesh
9413 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
9414 # that have this configuration.
9415 { # Container for either a built-in LB policy supported by gRPC or Envoy or
9416 # a custom one implemented by the end user.
9417 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
9418 # deployed with the client.
9419 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
9420 # by a locally installed custom policy implementation.
9421 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
9422 #
9423 # The value should match the name of a custom implementation registered
9424 # on the gRPC clients. It should follow protocol buffer message naming
9425 # conventions and include the full path (for example,
9426 # myorg.CustomLbPolicy). The maximum length is 256 characters.
9427 #
9428 # Do not specify the same custom policy more than once for a
9429 # backend. If you do, the configuration is rejected.
9430 #
9431 # For an example of how to use this field, seeUse
9432 # a custom policy.
9433 },
9434 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
9435 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
9436 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
9437 # about these values, see the description of localityLbPolicy.
9438 #
9439 # Do not specify the same policy more than once for a
9440 # backend. If you do, the configuration is rejected.
9441 },
9442 },
9443 ],
9444 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
9445 # possible values are:
9446 #
9447 # - ROUND_ROBIN: This is a simple policy in which each healthy
9448 # backend is selected in round robin order. This is the default.
9449 # - LEAST_REQUEST: An O(1) algorithm which
9450 # selects two random healthy hosts and picks the host which has fewer active
9451 # requests.
9452 # - RING_HASH: The ring/modulo hash load balancer implements
9453 # consistent hashing to backends. The algorithm has the property that the
9454 # addition/removal of a host from a set of N hosts only affects 1/N of the
9455 # requests.
9456 # - RANDOM: The load balancer selects a random healthy
9457 # host.
9458 # - ORIGINAL_DESTINATION: Backend host is selected
9459 # based on the client connection metadata, i.e., connections are opened to
9460 # the same address as the destination address of the incoming connection
9461 # before the connection was redirected to the load balancer.
9462 # - MAGLEV: used as a drop in replacement for the ring hash
9463 # load balancer. Maglev is not as stable as ring hash but has faster table
9464 # lookup build times and host selection times. For more information about
9465 # Maglev, see Maglev:
9466 # A Fast and Reliable Software Network Load Balancer.
9467 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
9468 # Load Balancing using weights computed from Backend reported Custom Metrics.
9469 # If set, the Backend Service responses are expected to contain non-standard
9470 # HTTP response header field Endpoint-Load-Metrics. The reported
9471 # metrics to use for computing the weights are specified via thecustomMetrics field.
9472 #
9473 # This field is applicable to either:
9474 # - A regional backend service with the service protocol set to HTTP,
9475 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
9476 # INTERNAL_MANAGED.
9477 # - A global backend service with the
9478 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
9479 # EXTERNAL_MANAGED.
9480 #
9481 #
9482 # If sessionAffinity is not configured—that is, if session
9483 # affinity remains at the default value of NONE—then the
9484 # default value for localityLbPolicy
9485 # is ROUND_ROBIN. If session affinity is set to a value other
9486 # than NONE,
9487 # then the default value for localityLbPolicy isMAGLEV.
9488 #
9489 # Only ROUND_ROBIN and RING_HASH are supported
9490 # when the backend service is referenced by a URL map that is bound to
9491 # target gRPC proxy that has validateForProxyless field set to true.
9492 #
9493 # localityLbPolicy cannot be specified with haPolicy.
9494 &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
9495 # by this backend service. If logging is enabled, logs will be exported to
9496 # Stackdriver.
9497 # backend service.
9498 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
9499 # traffic served by this backend service. The default value is false.
9500 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
9501 { # Determines which HTTP headers will be logged to Stackdriver.
9502 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
9503 },
9504 ],
9505 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
9506 { # Determines which HTTP headers will be logged to Stackdriver.
9507 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
9508 },
9509 ],
9510 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
9511 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
9512 # of optional fields you want to include in the logs. For example:
9513 # serverInstance, serverGkeDetails.cluster,
9514 # serverGkeDetails.pod.podNamespace
9515 &quot;A String&quot;,
9516 ],
9517 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
9518 # service. Configures whether all, none or a subset of optional fields
9519 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
9520 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
9521 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
9522 # service. The value of the field must be in [0, 1]. This configures the
9523 # sampling rate of requests to the load balancer where 1.0 means all logged
9524 # requests are reported and 0.0 means no logged requests are reported. The
9525 # default value is 1.0.
9526 },
9527 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
9528 # service. Duration is computed from the beginning of the stream until the
9529 # response has been completely processed, including all retries. A stream
9530 # that does not complete in this duration is closed.
9531 #
9532 # If not specified, there will be no timeout limit, i.e. the maximum
9533 # duration is infinite.
9534 #
9535 # This value can be overridden in the PathMatcher configuration of the
9536 # UrlMap that references this backend service.
9537 #
9538 # This field is only allowed when the loadBalancingScheme of
9539 # the backend service is INTERNAL_SELF_MANAGED.
9540 # as a count of seconds and fractions of seconds at nanosecond
9541 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
9542 # or &quot;month&quot;. Range is approximately 10,000 years.
9543 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
9544 # Durations less than one second are represented with a 0
9545 # `seconds` field and a positive `nanos` field. Must be from 0
9546 # to 999,999,999 inclusive.
9547 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
9548 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
9549 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
9550 },
9551 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
9552 # controller and read by the backend RCTH
9553 &quot;a_key&quot;: &quot;A String&quot;,
9554 },
9555 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
9556 # The name must be 1-63 characters long, and comply withRFC1035.
9557 # Specifically, the name must be 1-63 characters long and match the regular
9558 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
9559 # character must be a lowercase letter, and all following characters must
9560 # be a dash, lowercase letter, or digit, except the last character, which
9561 # cannot be a dash.
9562 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
9563 #
9564 # This field must be set for Internal Passthrough Network Load Balancers when
9565 # the haPolicy is enabled, and for External Passthrough Network Load
9566 # Balancers when the haPolicy fastIpMove is enabled.
9567 #
9568 # 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.
9569 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
9570 # Load Balancers.
9571 #
9572 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
9573 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
9574 # endpoints in the local zone.
9575 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
9576 # possible values are:
9577 #
9578 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
9579 # is disabled. The load balancer distributes new connections to all
9580 # healthy backend endpoints across all zones.
9581 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
9582 # enabled. The load balancer distributes new connections to all healthy
9583 # backend endpoints in the local zone only. If there are no healthy
9584 # backend endpoints in the local zone, the load balancer distributes
9585 # new connections to all backend endpoints in the local zone.
9586 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
9587 # enabled. The load balancer distributes new connections to all healthy
9588 # backend endpoints in the local zone only. If there aren&#x27;t enough
9589 # healthy backend endpoints in the local zone, the load balancer
9590 # distributes new connections to all healthy backend endpoints across all
9591 # zones.
9592 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
9593 # of healthy backend endpoints in a zone to the count of backend
9594 # endpoints in that same zone is equal to or above this threshold, the
9595 # load balancer distributes new connections to all healthy endpoints in
9596 # the local zone only. When the ratio of the count of healthy backend
9597 # endpoints in a zone to the count of backend endpoints in that same
9598 # zone is below this threshold, the load balancer distributes all new
9599 # connections to all healthy endpoints across all zones.
9600 },
9601 },
9602 &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.
9603 # the backend service.
9604 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
9605 # service.
9606 },
9607 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
9608 # load balancing pool of each individual proxy instance that processes the
9609 # traffic for the given backend service. If not set, this feature is
9610 # considered disabled.
9611 #
9612 # Results of the outlier detection algorithm (ejection of endpoints from the
9613 # load balancing pool and returning them back to the pool) are executed
9614 # independently by each proxy instance of the load balancer. In most cases,
9615 # more than one proxy instance handles the traffic received by a backend
9616 # service. Thus, it is possible that an unhealthy endpoint is detected and
9617 # ejected by only some of the proxies, and while this happens, other proxies
9618 # may continue to send requests to the same unhealthy endpoint until they
9619 # detect and eject the unhealthy endpoint.
9620 #
9621 # Applicable backend endpoints can be:
9622 #
9623 # - VM instances in an Instance Group
9624 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
9625 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
9626 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
9627 # Functions Services
9628 # - Private Service Connect NEGs, that resolve to
9629 # Google-managed regional API endpoints or managed services published using
9630 # Private Service Connect
9631 #
9632 #
9633 #
9634 # Applicable backend service types can be:
9635 #
9636 # - A global backend service with the loadBalancingScheme set to
9637 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
9638 # - A regional backend
9639 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
9640 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
9641 # supported for Serverless NEGs.
9642 #
9643 #
9644 #
9645 # Not supported when the backend service is referenced by a URL map that is
9646 # bound to target gRPC proxy that has validateForProxyless field set to true.
9647 # pool for the backend service.
9648 &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
9649 # or 30s.
9650 #
9651 # After a backend endpoint is returned back to the load balancing pool, it
9652 # can be ejected again in another ejection analysis. Thus, the total ejection
9653 # time is equal to the base ejection time multiplied by the number of times
9654 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
9655 # as a count of seconds and fractions of seconds at nanosecond
9656 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
9657 # or &quot;month&quot;. Range is approximately 10,000 years.
9658 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
9659 # Durations less than one second are represented with a 0
9660 # `seconds` field and a positive `nanos` field. Must be from 0
9661 # to 999,999,999 inclusive.
9662 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
9663 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
9664 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
9665 },
9666 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
9667 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
9668 # return code qualifies as an error. Defaults to 5.
9669 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
9670 # connection errors that are mapped to one of those status codes) before a
9671 # consecutive gateway failure ejection occurs. Defaults to 3.
9672 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
9673 # outlier status is detected through consecutive 5xx. This setting can be
9674 # used to disable ejection or to ramp it up slowly. Defaults to 0.
9675 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
9676 # outlier status is detected through consecutive gateway failures. This
9677 # setting can be used to disable ejection or to ramp it up slowly. Defaults
9678 # to 100.
9679 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
9680 # outlier status is detected through success rate statistics. This setting
9681 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
9682 #
9683 # Not supported when the backend service uses Serverless NEG.
9684 &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
9685 # ejections and backend endpoints being returned to service. The interval is
9686 # equal to the number of seconds as defined in
9687 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
9688 # in outlierDetection.interval.nanos. Defaults to 1 second.
9689 # as a count of seconds and fractions of seconds at nanosecond
9690 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
9691 # or &quot;month&quot;. Range is approximately 10,000 years.
9692 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
9693 # Durations less than one second are represented with a 0
9694 # `seconds` field and a positive `nanos` field. Must be from 0
9695 # to 999,999,999 inclusive.
9696 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
9697 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
9698 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
9699 },
9700 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
9701 # backend service that can be ejected if the ejection conditions are met.
9702 # Defaults to 50%.
9703 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
9704 # enough request volume to detect success rate outliers. If the number of
9705 # backend endpoints is fewer than this setting, outlier detection via success
9706 # rate statistics is not performed for any backend endpoint in the load
9707 # balancing pool. Defaults to 5.
9708 #
9709 # Not supported when the backend service uses Serverless NEG.
9710 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
9711 # (as defined by the interval duration above) to include this backend
9712 # endpoint in success rate based outlier detection. If the volume is lower
9713 # than this setting, outlier detection via success rate statistics is not
9714 # performed for that backend endpoint. Defaults to 100.
9715 #
9716 # Not supported when the backend service uses Serverless NEG.
9717 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
9718 # outlier ejection. The ejection threshold is the difference between the mean
9719 # success rate, and the product of this factor and the standard deviation of
9720 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
9721 # is divided by a thousand to get a double. That is, if the desired factor
9722 # is 1.9, the runtime value should be 1900. Defaults to 1900.
9723 #
9724 # Not supported when the backend service uses Serverless NEG.
9725 },
9726 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
9727 # as part of resource payload.
9728 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
9729 # Tag keys and values have the same definition as resource
9730 # manager tags. The field is allowed for INSERT
9731 # only. The keys/values to set on the resource should be specified in
9732 # either ID { : } or Namespaced format
9733 # { : }.
9734 # For example the following are valid inputs:
9735 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
9736 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
9737 # Note:
9738 # * Invalid combinations of ID &amp; namespaced format is not supported. For
9739 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
9740 &quot;a_key&quot;: &quot;A String&quot;,
9741 },
9742 },
9743 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
9744 # the backend. The default value is 80.
9745 # For internal passthrough Network Load Balancers and external passthrough
9746 # Network Load Balancers, omit port.
9747 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
9748 # communication to the backend VMs in that group. The
9749 # named port must be [defined on each backend instance
9750 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
9751 # This parameter has no meaning if the backends are NEGs. For internal
9752 # passthrough Network Load Balancers and external passthrough Network Load
9753 # Balancers, omit port_name.
9754 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
9755 # with backends.
9756 #
9757 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
9758 # depending on the chosen load balancer or Traffic Director configuration.
9759 # Refer to the documentation for the load balancers or for Traffic Director
9760 # for more information.
9761 #
9762 # Must be set to GRPC when the backend service is referenced by a URL map
9763 # that is bound to target gRPC proxy.
9764 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
9765 # resides. This field is not applicable to global backend services.
9766 # You must specify this field as part of the HTTP request URL. It is
9767 # not settable as a field in the request body.
9768 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
9769 # backend service.
9770 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
9771 # service. This field is applicable to a global backend service with the
9772 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
9773 &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
9774 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
9775 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
9776 # private storage buckets that support Signature Version 4 for authentication.
9777 # The service name for generating the authentication header will always default
9778 # to &#x27;s3&#x27;.
9779 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
9780 # creating a backend that uses AWS v4 signature authentication, but will not
9781 # be returned as part of the configuration when queried with a REST API GET
9782 # request.
9783 #
9784 # @InputOnly
9785 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
9786 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
9787 # keep track of different iterations of your access key.
9788 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
9789 # the name of the region your cloud uses to host your origin. For example,
9790 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
9791 },
9792 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
9793 # that describes how clients should authenticate with this service&#x27;s
9794 # backends.
9795 #
9796 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
9797 # to INTERNAL_SELF_MANAGED.
9798 #
9799 # If left blank, communications are not encrypted.
9800 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
9801 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
9802 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
9803 # specified values, the communication continues. Otherwise, it fails. This
9804 # additional check enables the client to verify that the server is authorized
9805 # to run the requested service.
9806 #
9807 # Note that the contents of the server
9808 # certificate&#x27;s subjectAltName field are configured by the
9809 # Public Key Infrastructure which provisions server identities.
9810 #
9811 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
9812 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
9813 # mode).
9814 &quot;A String&quot;,
9815 ],
9816 },
9817 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
9818 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
9819 #
9820 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
9821 # If set, lists of backends and health checks must be both empty.
9822 &quot;A String&quot;,
9823 ],
9824 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
9825 #
9826 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
9827 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
9828 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
9829 #
9830 # Only NONE and HEADER_FIELD are supported
9831 # when the backend service is referenced by a URL map that is bound to
9832 # target gRPC proxy that has validateForProxyless field set to true.
9833 #
9834 # For more details, see:
9835 # [Session
9836 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
9837 #
9838 # sessionAffinity cannot be specified with haPolicy.
9839 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
9840 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
9841 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
9842 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
9843 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
9844 # as a count of seconds and fractions of seconds at nanosecond
9845 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
9846 # or &quot;month&quot;. Range is approximately 10,000 years.
9847 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
9848 # Durations less than one second are represented with a 0
9849 # `seconds` field and a positive `nanos` field. Must be from 0
9850 # to 999,999,999 inclusive.
9851 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
9852 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
9853 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
9854 },
9855 },
9856 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
9857 # Currently this is applicable only for Internal TCP/UDP load balancing,
9858 # Internal HTTP(S) load balancing and Traffic Director.
9859 &quot;policy&quot;: &quot;A String&quot;,
9860 },
9861 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
9862 # type of load balancer. For more information see,
9863 # Backend service settings.
9864 # The default is 30 seconds.
9865 # The full range of timeout values allowed goes from 1
9866 # through 2,147,483,647 seconds.
9867 #
9868 # This value can be overridden in the PathMatcher configuration of the
9869 # UrlMap that references this backend service.
9870 #
9871 # Not supported when the backend service is referenced by a URL map that is
9872 # bound to target gRPC proxy that has validateForProxyless field set to true.
9873 # Instead, use maxStreamDuration.
9874 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
9875 # when the backend protocol is SSL, HTTPS or HTTP2.
9876 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
9877 # networksecurity.googleapis.com namespace. Can be used in authenticating
9878 # TLS connections to the backend, as specified by the authenticationMode
9879 # field. Can only be specified if authenticationMode is not NONE.
9880 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
9881 # balancer sends this string as the SNI hostname in the TLS connection to
9882 # the backend, and requires that this string match a Subject Alternative
9883 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
9884 # NEG backend, if the SNI is specified here, the load balancer uses it
9885 # regardless of whether the Regional Internet NEG is specified with FQDN or
9886 # IP address and port. When both sni and subjectAltNames[] are specified,
9887 # the load balancer matches the backend certificate&#x27;s SAN only to
9888 # subjectAltNames[].
9889 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
9890 # verifies during a TLS handshake with the backend. When the server
9891 # presents its X.509 certificate to the Load Balancer, the Load Balancer
9892 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
9893 # match one of the subjectAltNames in the list. This field is limited to 5
9894 # entries. When both sni and subjectAltNames[] are specified, the load
9895 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
9896 { # A Subject Alternative Name that the load balancer matches against the SAN
9897 # field in the TLS certificate provided by the backend, specified as either
9898 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
9899 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
9900 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
9901 },
9902 ],
9903 },
9904 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
9905 {
9906 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
9907 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
9908 # and ForwardingRule.
9909 },
9910 ],
9911 }
9912
9913 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
9914 that if you must retry your request, the server will know to ignore the
9915 request if it has already been completed.
9916
9917 For example, consider a situation where you make an initial request and
9918 the request times out. If you make the request again with the same
9919 request ID, the server can check if original operation with the same
9920 request ID was received, and if so, will ignore the second request. This
9921 prevents clients from accidentally creating duplicate commitments.
9922
9923 The request ID must be
9924 a valid UUID with the exception that zero UUID is not supported
9925 (00000000-0000-0000-0000-000000000000).
9926 x__xgafv: string, V1 error format.
9927 Allowed values
9928 1 - v1 error format
9929 2 - v2 error format
9930
9931 Returns:
9932 An object of the form:
9933
9934 { # Represents an Operation resource.
9935 #
9936 # Google Compute Engine has three Operation resources:
9937 #
9938 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
9939 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
9940 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
9941 #
9942 # You can use an operation resource to manage asynchronous API requests.
9943 # For more information, readHandling
9944 # API responses.
9945 #
9946 # Operations can be global, regional or zonal.
9947 #
9948 # - For global operations, use the `globalOperations`
9949 # resource.
9950 # - For regional operations, use the
9951 # `regionOperations` resource.
9952 # - For zonal operations, use
9953 # the `zoneOperations` resource.
9954 #
9955 #
9956 #
9957 # For more information, read
9958 # Global, Regional, and Zonal Resources.
9959 #
9960 # Note that completed Operation resources have a limited
9961 # retention period.
9962 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
9963 # Not present otherwise.
9964 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
9965 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
9966 # set when the operation is created.
9967 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
9968 # text format.
9969 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
9970 # this field will be populated.
9971 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
9972 # operation.
9973 {
9974 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
9975 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
9976 # details. There is a set of defined message types to use for providing
9977 # details.The syntax depends on the error code. For example,
9978 # QuotaExceededInfo will have details when the error code is
9979 # QUOTA_EXCEEDED.
9980 {
9981 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
9982 #
9983 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
9984 # is not enabled:
9985 #
9986 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
9987 # &quot;domain&quot;: &quot;googleapis.com&quot;
9988 # &quot;metadata&quot;: {
9989 # &quot;resource&quot;: &quot;projects/123&quot;,
9990 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
9991 # }
9992 # }
9993 #
9994 # This response indicates that the pubsub.googleapis.com API is not enabled.
9995 #
9996 # Example of an error that is returned when attempting to create a Spanner
9997 # instance in a region that is out of stock:
9998 #
9999 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
10000 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
10001 # &quot;metadata&quot;: {
10002 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
10003 # }
10004 # }
10005 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
10006 # is typically the registered service name of the tool or product that
10007 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
10008 # generated by some common infrastructure, the error domain must be a
10009 # globally unique value that identifies the infrastructure. For Google API
10010 # infrastructure, the error domain is &quot;googleapis.com&quot;.
10011 &quot;metadatas&quot;: { # Additional structured details about this error.
10012 #
10013 # Keys must match a regular expression of `a-z+` but should
10014 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
10015 # length. When identifying the current value of an exceeded limit, the units
10016 # should be contained in the key, not the value. For example, rather than
10017 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
10018 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
10019 # instances that can be created in a single (batch) request.
10020 &quot;a_key&quot;: &quot;A String&quot;,
10021 },
10022 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
10023 # proximate cause of the error. Error reasons are unique within a particular
10024 # domain of errors. This should be at most 63 characters and match a
10025 # regular expression of `A-Z+[A-Z0-9]`, which represents
10026 # UPPER_SNAKE_CASE.
10027 },
10028 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
10029 #
10030 # For example, if a quota check failed with an error indicating the calling
10031 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
10032 # directly to the right place in the developer console to flip the bit.
10033 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
10034 { # Describes a URL link.
10035 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
10036 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
10037 },
10038 ],
10039 },
10040 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
10041 # which can be attached to an RPC error.
10042 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
10043 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
10044 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
10045 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
10046 },
10047 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
10048 &quot;dimensions&quot;: { # The map holding related quota dimensions.
10049 &quot;a_key&quot;: &quot;A String&quot;,
10050 },
10051 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
10052 # type or metric.
10053 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
10054 # or metric.
10055 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
10056 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
10057 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
10058 },
10059 },
10060 ],
10061 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
10062 # This property is optional.
10063 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
10064 },
10065 ],
10066 },
10067 &quot;getVersionOperationMetadata&quot;: {
10068 &quot;inlineSbomInfo&quot;: {
10069 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
10070 # appropriate identifiers.
10071 &quot;a_key&quot;: &quot;A String&quot;,
10072 },
10073 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
10074 # identifiers.
10075 &quot;a_key&quot;: &quot;A String&quot;,
10076 },
10077 },
10078 },
10079 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
10080 # message that was returned, such as `NOT FOUND`.
10081 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
10082 # status code that was returned. For example, a `404` means the
10083 # resource was not found.
10084 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
10085 # defined by the server.
10086 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
10087 # This value is inRFC3339
10088 # text format.
10089 &quot;instancesBulkInsertOperationMetadata&quot;: {
10090 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
10091 # Example key: zones/us-central1-a
10092 &quot;a_key&quot;: {
10093 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
10094 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
10095 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
10096 # error.
10097 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
10098 # if the flow is rolling forward or rolling back.
10099 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
10100 },
10101 },
10102 },
10103 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
10104 # Operation resources.
10105 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
10106 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
10107 # group of operations results from a `bulkInsert` API request.
10108 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
10109 # `update`, or `delete`, and so on.
10110 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
10111 # There is no requirement that this be linear or support any granularity of
10112 # operations. This should not be used to guess when the operation will be
10113 # complete. This number should monotonically increase as the operation
10114 # progresses.
10115 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
10116 # applicable when performing regional operations.
10117 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
10118 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
10119 # this field will contain information on all underlying zonal actions and
10120 # their state.
10121 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
10122 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
10123 # Example key: zones/us-central1-a
10124 &quot;a_key&quot;: {
10125 &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
10126 # populated.
10127 # different programming environments, including REST APIs and RPC APIs. It is
10128 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
10129 # three pieces of data: error code, error message, and error details.
10130 #
10131 # You can find out more about this error model and how to work with it in the
10132 # [API Design Guide](https://cloud.google.com/apis/design/errors).
10133 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
10134 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
10135 # message types for APIs to use.
10136 {
10137 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
10138 },
10139 ],
10140 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
10141 # user-facing error message should be localized and sent in the
10142 # google.rpc.Status.details field, or localized by the client.
10143 },
10144 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
10145 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
10146 },
10147 },
10148 },
10149 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
10150 # This value is inRFC3339
10151 # text format.
10152 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
10153 # following:
10154 # `PENDING`, `RUNNING`, or `DONE`.
10155 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
10156 # operation.
10157 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
10158 # of the target resource.
10159 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
10160 # operations related to creating a snapshot, this points to the disk
10161 # that the snapshot was created from.
10162 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
10163 # `[email protected]` or
10164 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
10165 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
10166 # operation, this field will be populated.
10167 {
10168 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
10169 # Engine returns NO_RESULTS_ON_PAGE if there
10170 # are no results in the response.
10171 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
10172 # value format. For example:
10173 #
10174 # &quot;data&quot;: [
10175 # {
10176 # &quot;key&quot;: &quot;scope&quot;,
10177 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
10178 # }
10179 {
10180 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
10181 # returned. For example, for warnings where there are no results in a list
10182 # request for a particular zone, this key might be scope and
10183 # the key value might be the zone name. Other examples might be a key
10184 # indicating a deprecated resource and a suggested replacement, or a
10185 # warning about invalid network settings (for example, if an instance
10186 # attempts to perform IP forwarding but is not enabled for IP forwarding).
10187 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
10188 },
10189 ],
10190 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
10191 },
10192 ],
10193 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
10194 # applicable when performing per-zone operations.
10195 }</pre>
10196 </div>
10197
10198 <div class="method">
10199 <code class="details" id="setEdgeSecurityPolicy">setEdgeSecurityPolicy(project, backendService, body=None, requestId=None, x__xgafv=None)</code>
10200 <pre>Sets the edge security policy for the specified backend service.
10201
10202 Args:
10203 project: string, Project ID for this request. (required)
10204 backendService: string, Name of the BackendService resource to which the edge security policy
10205 should be set. The name should conform to RFC1035. (required)
10206 body: object, The request body.
10207 The object takes the form of:
10208
10209 {
10210 &quot;securityPolicy&quot;: &quot;A String&quot;,
10211 }
10212
10213 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
10214 that if you must retry your request, the server will know to ignore the
10215 request if it has already been completed.
10216
10217 For example, consider a situation where you make an initial request and
10218 the request times out. If you make the request again with the same
10219 request ID, the server can check if original operation with the same
10220 request ID was received, and if so, will ignore the second request. This
10221 prevents clients from accidentally creating duplicate commitments.
10222
10223 The request ID must be
10224 a valid UUID with the exception that zero UUID is not supported
10225 (00000000-0000-0000-0000-000000000000).
10226 x__xgafv: string, V1 error format.
10227 Allowed values
10228 1 - v1 error format
10229 2 - v2 error format
10230
10231 Returns:
10232 An object of the form:
10233
10234 { # Represents an Operation resource.
10235 #
10236 # Google Compute Engine has three Operation resources:
10237 #
10238 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
10239 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
10240 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
10241 #
10242 # You can use an operation resource to manage asynchronous API requests.
10243 # For more information, readHandling
10244 # API responses.
10245 #
10246 # Operations can be global, regional or zonal.
10247 #
10248 # - For global operations, use the `globalOperations`
10249 # resource.
10250 # - For regional operations, use the
10251 # `regionOperations` resource.
10252 # - For zonal operations, use
10253 # the `zoneOperations` resource.
10254 #
10255 #
10256 #
10257 # For more information, read
10258 # Global, Regional, and Zonal Resources.
10259 #
10260 # Note that completed Operation resources have a limited
10261 # retention period.
10262 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
10263 # Not present otherwise.
10264 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
10265 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
10266 # set when the operation is created.
10267 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
10268 # text format.
10269 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
10270 # this field will be populated.
10271 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
10272 # operation.
10273 {
10274 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
10275 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
10276 # details. There is a set of defined message types to use for providing
10277 # details.The syntax depends on the error code. For example,
10278 # QuotaExceededInfo will have details when the error code is
10279 # QUOTA_EXCEEDED.
10280 {
10281 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
10282 #
10283 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
10284 # is not enabled:
10285 #
10286 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
10287 # &quot;domain&quot;: &quot;googleapis.com&quot;
10288 # &quot;metadata&quot;: {
10289 # &quot;resource&quot;: &quot;projects/123&quot;,
10290 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
10291 # }
10292 # }
10293 #
10294 # This response indicates that the pubsub.googleapis.com API is not enabled.
10295 #
10296 # Example of an error that is returned when attempting to create a Spanner
10297 # instance in a region that is out of stock:
10298 #
10299 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
10300 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
10301 # &quot;metadata&quot;: {
10302 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
10303 # }
10304 # }
10305 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
10306 # is typically the registered service name of the tool or product that
10307 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
10308 # generated by some common infrastructure, the error domain must be a
10309 # globally unique value that identifies the infrastructure. For Google API
10310 # infrastructure, the error domain is &quot;googleapis.com&quot;.
10311 &quot;metadatas&quot;: { # Additional structured details about this error.
10312 #
10313 # Keys must match a regular expression of `a-z+` but should
10314 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
10315 # length. When identifying the current value of an exceeded limit, the units
10316 # should be contained in the key, not the value. For example, rather than
10317 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
10318 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
10319 # instances that can be created in a single (batch) request.
10320 &quot;a_key&quot;: &quot;A String&quot;,
10321 },
10322 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
10323 # proximate cause of the error. Error reasons are unique within a particular
10324 # domain of errors. This should be at most 63 characters and match a
10325 # regular expression of `A-Z+[A-Z0-9]`, which represents
10326 # UPPER_SNAKE_CASE.
10327 },
10328 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
10329 #
10330 # For example, if a quota check failed with an error indicating the calling
10331 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
10332 # directly to the right place in the developer console to flip the bit.
10333 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
10334 { # Describes a URL link.
10335 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
10336 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
10337 },
10338 ],
10339 },
10340 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
10341 # which can be attached to an RPC error.
10342 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
10343 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
10344 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
10345 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
10346 },
10347 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
10348 &quot;dimensions&quot;: { # The map holding related quota dimensions.
10349 &quot;a_key&quot;: &quot;A String&quot;,
10350 },
10351 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
10352 # type or metric.
10353 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
10354 # or metric.
10355 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
10356 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
10357 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
10358 },
10359 },
10360 ],
10361 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
10362 # This property is optional.
10363 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
10364 },
10365 ],
10366 },
10367 &quot;getVersionOperationMetadata&quot;: {
10368 &quot;inlineSbomInfo&quot;: {
10369 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
10370 # appropriate identifiers.
10371 &quot;a_key&quot;: &quot;A String&quot;,
10372 },
10373 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
10374 # identifiers.
10375 &quot;a_key&quot;: &quot;A String&quot;,
10376 },
10377 },
10378 },
10379 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
10380 # message that was returned, such as `NOT FOUND`.
10381 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
10382 # status code that was returned. For example, a `404` means the
10383 # resource was not found.
10384 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
10385 # defined by the server.
10386 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
10387 # This value is inRFC3339
10388 # text format.
10389 &quot;instancesBulkInsertOperationMetadata&quot;: {
10390 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
10391 # Example key: zones/us-central1-a
10392 &quot;a_key&quot;: {
10393 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
10394 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
10395 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
10396 # error.
10397 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
10398 # if the flow is rolling forward or rolling back.
10399 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
10400 },
10401 },
10402 },
10403 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
10404 # Operation resources.
10405 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
10406 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
10407 # group of operations results from a `bulkInsert` API request.
10408 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
10409 # `update`, or `delete`, and so on.
10410 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
10411 # There is no requirement that this be linear or support any granularity of
10412 # operations. This should not be used to guess when the operation will be
10413 # complete. This number should monotonically increase as the operation
10414 # progresses.
10415 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
10416 # applicable when performing regional operations.
10417 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
10418 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
10419 # this field will contain information on all underlying zonal actions and
10420 # their state.
10421 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
10422 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
10423 # Example key: zones/us-central1-a
10424 &quot;a_key&quot;: {
10425 &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
10426 # populated.
10427 # different programming environments, including REST APIs and RPC APIs. It is
10428 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
10429 # three pieces of data: error code, error message, and error details.
10430 #
10431 # You can find out more about this error model and how to work with it in the
10432 # [API Design Guide](https://cloud.google.com/apis/design/errors).
10433 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
10434 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
10435 # message types for APIs to use.
10436 {
10437 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
10438 },
10439 ],
10440 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
10441 # user-facing error message should be localized and sent in the
10442 # google.rpc.Status.details field, or localized by the client.
10443 },
10444 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
10445 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
10446 },
10447 },
10448 },
10449 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
10450 # This value is inRFC3339
10451 # text format.
10452 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
10453 # following:
10454 # `PENDING`, `RUNNING`, or `DONE`.
10455 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
10456 # operation.
10457 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
10458 # of the target resource.
10459 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
10460 # operations related to creating a snapshot, this points to the disk
10461 # that the snapshot was created from.
10462 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
10463 # `[email protected]` or
10464 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
10465 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
10466 # operation, this field will be populated.
10467 {
10468 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
10469 # Engine returns NO_RESULTS_ON_PAGE if there
10470 # are no results in the response.
10471 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
10472 # value format. For example:
10473 #
10474 # &quot;data&quot;: [
10475 # {
10476 # &quot;key&quot;: &quot;scope&quot;,
10477 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
10478 # }
10479 {
10480 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
10481 # returned. For example, for warnings where there are no results in a list
10482 # request for a particular zone, this key might be scope and
10483 # the key value might be the zone name. Other examples might be a key
10484 # indicating a deprecated resource and a suggested replacement, or a
10485 # warning about invalid network settings (for example, if an instance
10486 # attempts to perform IP forwarding but is not enabled for IP forwarding).
10487 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
10488 },
10489 ],
10490 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
10491 },
10492 ],
10493 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
10494 # applicable when performing per-zone operations.
10495 }</pre>
10496 </div>
10497
10498 <div class="method">
10499 <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</code>
10500 <pre>Sets the access control policy on the specified resource.
10501 Replaces any existing policy.
10502
10503 Args:
10504 project: string, Project ID for this request. (required)
10505 resource: string, Name or id of the resource for this request. (required)
10506 body: object, The request body.
10507 The object takes the form of:
10508
10509 {
10510 &quot;bindings&quot;: [ # Flatten Policy to create a backward compatible wire-format.
10511 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
10512 { # Associates `members`, or principals, with a `role`.
10513 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
10514 #
10515 # If the condition evaluates to `true`, then this binding applies to the
10516 # current request.
10517 #
10518 # If the condition evaluates to `false`, then this binding does not apply to
10519 # the current request. However, a different role binding might grant the same
10520 # role to one or more of the principals in this binding.
10521 #
10522 # To learn which resources support conditions in their IAM policies, see the
10523 # [IAM
10524 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
10525 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
10526 # are documented at https://github.com/google/cel-spec.
10527 #
10528 # Example (Comparison):
10529 #
10530 # title: &quot;Summary size limit&quot;
10531 # description: &quot;Determines if a summary is less than 100 chars&quot;
10532 # expression: &quot;document.summary.size() &lt; 100&quot;
10533 #
10534 # Example (Equality):
10535 #
10536 # title: &quot;Requestor is owner&quot;
10537 # description: &quot;Determines if requestor is the document owner&quot;
10538 # expression: &quot;document.owner == request.auth.claims.email&quot;
10539 #
10540 # Example (Logic):
10541 #
10542 # title: &quot;Public documents&quot;
10543 # description: &quot;Determine whether the document should be publicly visible&quot;
10544 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
10545 #
10546 # Example (Data Manipulation):
10547 #
10548 # title: &quot;Notification string&quot;
10549 # description: &quot;Create a notification string with a timestamp.&quot;
10550 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
10551 #
10552 # The exact variables and functions that may be referenced within an expression
10553 # are determined by the service that evaluates it. See the service
10554 # documentation for additional information.
10555 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
10556 # describes the expression, e.g. when hovered over it in a UI.
10557 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
10558 # syntax.
10559 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
10560 # reporting, e.g. a file name and a position in the file.
10561 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
10562 # its purpose. This can be used e.g. in UIs which allow to enter the
10563 # expression.
10564 },
10565 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
10566 # `members` can have the following values:
10567 #
10568 # * `allUsers`: A special identifier that represents anyone who is
10569 # on the internet; with or without a Google account.
10570 #
10571 # * `allAuthenticatedUsers`: A special identifier that represents anyone
10572 # who is authenticated with a Google account or a service account.
10573 # Does not include identities that come from external identity providers
10574 # (IdPs) through identity federation.
10575 #
10576 # * `user:{emailid}`: An email address that represents a specific Google
10577 # account. For example, `[email protected]` .
10578 #
10579 #
10580 # * `serviceAccount:{emailid}`: An email address that represents a Google
10581 # service account. For example,
10582 # `[email protected]`.
10583 #
10584 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
10585 # identifier for a
10586 # [Kubernetes service
10587 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
10588 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
10589 #
10590 # * `group:{emailid}`: An email address that represents a Google group.
10591 # For example, `[email protected]`.
10592 #
10593 #
10594 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
10595 # users of that domain. For example, `google.com` or `example.com`.
10596 #
10597 #
10598 #
10599 #
10600 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
10601 # A single identity in a workforce identity pool.
10602 #
10603 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
10604 # All workforce identities in a group.
10605 #
10606 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
10607 # All workforce identities with a specific attribute value.
10608 #
10609 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
10610 # All identities in a workforce identity pool.
10611 #
10612 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
10613 # A single identity in a workload identity pool.
10614 #
10615 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
10616 # A workload identity pool group.
10617 #
10618 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
10619 # All identities in a workload identity pool with a certain attribute.
10620 #
10621 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
10622 # All identities in a workload identity pool.
10623 #
10624 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
10625 # identifier) representing a user that has been recently deleted. For
10626 # example, `[email protected]?uid=123456789012345678901`. If the user is
10627 # recovered, this value reverts to `user:{emailid}` and the recovered user
10628 # retains the role in the binding.
10629 #
10630 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
10631 # unique identifier) representing a service account that has been recently
10632 # deleted. For example,
10633 # `[email protected]?uid=123456789012345678901`.
10634 # If the service account is undeleted, this value reverts to
10635 # `serviceAccount:{emailid}` and the undeleted service account retains the
10636 # role in the binding.
10637 #
10638 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
10639 # identifier) representing a Google group that has been recently
10640 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
10641 # the group is recovered, this value reverts to `group:{emailid}` and the
10642 # recovered group retains the role in the binding.
10643 #
10644 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
10645 # Deleted single identity in a workforce identity pool. For example,
10646 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
10647 &quot;A String&quot;,
10648 ],
10649 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
10650 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
10651 #
10652 # For an overview of the IAM roles and permissions, see the
10653 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
10654 # a list of the available pre-defined roles, see
10655 # [here](https://cloud.google.com/iam/docs/understanding-roles).
10656 },
10657 ],
10658 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
10659 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
10660 &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
10661 # the policy is limited to a few 10s of KB. An empty policy is in general a
10662 # valid policy but certain services (like Projects) might reject them.
10663 # controls for Google Cloud resources.
10664 #
10665 #
10666 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
10667 # `members`, or principals, to a single `role`. Principals can be user
10668 # accounts, service accounts, Google groups, and domains (such as G Suite). A
10669 # `role` is a named list of permissions; each `role` can be an IAM predefined
10670 # role or a user-created custom role.
10671 #
10672 # For some types of Google Cloud resources, a `binding` can also specify a
10673 # `condition`, which is a logical expression that allows access to a resource
10674 # only if the expression evaluates to `true`. A condition can add constraints
10675 # based on attributes of the request, the resource, or both. To learn which
10676 # resources support conditions in their IAM policies, see the
10677 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
10678 #
10679 # **JSON example:**
10680 #
10681 # ```
10682 # {
10683 # &quot;bindings&quot;: [
10684 # {
10685 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
10686 # &quot;members&quot;: [
10687 # &quot;user:[email protected]&quot;,
10688 # &quot;group:[email protected]&quot;,
10689 # &quot;domain:google.com&quot;,
10690 # &quot;serviceAccount:[email protected]&quot;
10691 # ]
10692 # },
10693 # {
10694 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
10695 # &quot;members&quot;: [
10696 # &quot;user:[email protected]&quot;
10697 # ],
10698 # &quot;condition&quot;: {
10699 # &quot;title&quot;: &quot;expirable access&quot;,
10700 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
10701 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
10702 # }
10703 # }
10704 # ],
10705 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
10706 # &quot;version&quot;: 3
10707 # }
10708 # ```
10709 #
10710 # **YAML example:**
10711 #
10712 # ```
10713 # bindings:
10714 # - members:
10715 # - user:[email protected]
10716 # - group:[email protected]
10717 # - domain:google.com
10718 # - serviceAccount:[email protected]
10719 # role: roles/resourcemanager.organizationAdmin
10720 # - members:
10721 # - user:[email protected]
10722 # role: roles/resourcemanager.organizationViewer
10723 # condition:
10724 # title: expirable access
10725 # description: Does not grant access after Sep 2020
10726 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
10727 # etag: BwWWja0YfJA=
10728 # version: 3
10729 # ```
10730 #
10731 # For a description of IAM and its features, see the
10732 # [IAM documentation](https://cloud.google.com/iam/docs/).
10733 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
10734 { # Specifies the audit configuration for a service.
10735 # The configuration determines which permission types are logged, and what
10736 # identities, if any, are exempted from logging.
10737 # An AuditConfig must have one or more AuditLogConfigs.
10738 #
10739 # If there are AuditConfigs for both `allServices` and a specific service,
10740 # the union of the two AuditConfigs is used for that service: the log_types
10741 # specified in each AuditConfig are enabled, and the exempted_members in each
10742 # AuditLogConfig are exempted.
10743 #
10744 # Example Policy with multiple AuditConfigs:
10745 #
10746 # {
10747 # &quot;audit_configs&quot;: [
10748 # {
10749 # &quot;service&quot;: &quot;allServices&quot;,
10750 # &quot;audit_log_configs&quot;: [
10751 # {
10752 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
10753 # &quot;exempted_members&quot;: [
10754 # &quot;user:[email protected]&quot;
10755 # ]
10756 # },
10757 # {
10758 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
10759 # },
10760 # {
10761 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
10762 # }
10763 # ]
10764 # },
10765 # {
10766 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
10767 # &quot;audit_log_configs&quot;: [
10768 # {
10769 # &quot;log_type&quot;: &quot;DATA_READ&quot;
10770 # },
10771 # {
10772 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
10773 # &quot;exempted_members&quot;: [
10774 # &quot;user:[email protected]&quot;
10775 # ]
10776 # }
10777 # ]
10778 # }
10779 # ]
10780 # }
10781 #
10782 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
10783 # logging. It also exempts `[email protected]` from DATA_READ logging, and
10784 # `[email protected]` from DATA_WRITE logging.
10785 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
10786 { # Provides the configuration for logging a type of permissions.
10787 # Example:
10788 #
10789 # {
10790 # &quot;audit_log_configs&quot;: [
10791 # {
10792 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
10793 # &quot;exempted_members&quot;: [
10794 # &quot;user:[email protected]&quot;
10795 # ]
10796 # },
10797 # {
10798 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
10799 # }
10800 # ]
10801 # }
10802 #
10803 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
10804 # [email protected] from DATA_READ logging.
10805 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
10806 # permission.
10807 # Follows the same format of Binding.members.
10808 &quot;A String&quot;,
10809 ],
10810 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
10811 },
10812 ],
10813 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
10814 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
10815 # `allServices` is a special value that covers all services.
10816 },
10817 ],
10818 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
10819 # may specify a `condition` that determines how and when the `bindings` are
10820 # applied. Each of the `bindings` must contain at least one principal.
10821 #
10822 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
10823 # of these principals can be Google groups. Each occurrence of a principal
10824 # counts towards these limits. For example, if the `bindings` grant 50
10825 # different roles to `user:[email protected]`, and not to any other
10826 # principal, then you can add another 1,450 principals to the `bindings` in
10827 # the `Policy`.
10828 { # Associates `members`, or principals, with a `role`.
10829 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
10830 #
10831 # If the condition evaluates to `true`, then this binding applies to the
10832 # current request.
10833 #
10834 # If the condition evaluates to `false`, then this binding does not apply to
10835 # the current request. However, a different role binding might grant the same
10836 # role to one or more of the principals in this binding.
10837 #
10838 # To learn which resources support conditions in their IAM policies, see the
10839 # [IAM
10840 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
10841 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
10842 # are documented at https://github.com/google/cel-spec.
10843 #
10844 # Example (Comparison):
10845 #
10846 # title: &quot;Summary size limit&quot;
10847 # description: &quot;Determines if a summary is less than 100 chars&quot;
10848 # expression: &quot;document.summary.size() &lt; 100&quot;
10849 #
10850 # Example (Equality):
10851 #
10852 # title: &quot;Requestor is owner&quot;
10853 # description: &quot;Determines if requestor is the document owner&quot;
10854 # expression: &quot;document.owner == request.auth.claims.email&quot;
10855 #
10856 # Example (Logic):
10857 #
10858 # title: &quot;Public documents&quot;
10859 # description: &quot;Determine whether the document should be publicly visible&quot;
10860 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
10861 #
10862 # Example (Data Manipulation):
10863 #
10864 # title: &quot;Notification string&quot;
10865 # description: &quot;Create a notification string with a timestamp.&quot;
10866 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
10867 #
10868 # The exact variables and functions that may be referenced within an expression
10869 # are determined by the service that evaluates it. See the service
10870 # documentation for additional information.
10871 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
10872 # describes the expression, e.g. when hovered over it in a UI.
10873 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
10874 # syntax.
10875 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
10876 # reporting, e.g. a file name and a position in the file.
10877 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
10878 # its purpose. This can be used e.g. in UIs which allow to enter the
10879 # expression.
10880 },
10881 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
10882 # `members` can have the following values:
10883 #
10884 # * `allUsers`: A special identifier that represents anyone who is
10885 # on the internet; with or without a Google account.
10886 #
10887 # * `allAuthenticatedUsers`: A special identifier that represents anyone
10888 # who is authenticated with a Google account or a service account.
10889 # Does not include identities that come from external identity providers
10890 # (IdPs) through identity federation.
10891 #
10892 # * `user:{emailid}`: An email address that represents a specific Google
10893 # account. For example, `[email protected]` .
10894 #
10895 #
10896 # * `serviceAccount:{emailid}`: An email address that represents a Google
10897 # service account. For example,
10898 # `[email protected]`.
10899 #
10900 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
10901 # identifier for a
10902 # [Kubernetes service
10903 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
10904 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
10905 #
10906 # * `group:{emailid}`: An email address that represents a Google group.
10907 # For example, `[email protected]`.
10908 #
10909 #
10910 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
10911 # users of that domain. For example, `google.com` or `example.com`.
10912 #
10913 #
10914 #
10915 #
10916 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
10917 # A single identity in a workforce identity pool.
10918 #
10919 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
10920 # All workforce identities in a group.
10921 #
10922 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
10923 # All workforce identities with a specific attribute value.
10924 #
10925 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
10926 # All identities in a workforce identity pool.
10927 #
10928 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
10929 # A single identity in a workload identity pool.
10930 #
10931 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
10932 # A workload identity pool group.
10933 #
10934 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
10935 # All identities in a workload identity pool with a certain attribute.
10936 #
10937 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
10938 # All identities in a workload identity pool.
10939 #
10940 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
10941 # identifier) representing a user that has been recently deleted. For
10942 # example, `[email protected]?uid=123456789012345678901`. If the user is
10943 # recovered, this value reverts to `user:{emailid}` and the recovered user
10944 # retains the role in the binding.
10945 #
10946 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
10947 # unique identifier) representing a service account that has been recently
10948 # deleted. For example,
10949 # `[email protected]?uid=123456789012345678901`.
10950 # If the service account is undeleted, this value reverts to
10951 # `serviceAccount:{emailid}` and the undeleted service account retains the
10952 # role in the binding.
10953 #
10954 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
10955 # identifier) representing a Google group that has been recently
10956 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
10957 # the group is recovered, this value reverts to `group:{emailid}` and the
10958 # recovered group retains the role in the binding.
10959 #
10960 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
10961 # Deleted single identity in a workforce identity pool. For example,
10962 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
10963 &quot;A String&quot;,
10964 ],
10965 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
10966 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
10967 #
10968 # For an overview of the IAM roles and permissions, see the
10969 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
10970 # a list of the available pre-defined roles, see
10971 # [here](https://cloud.google.com/iam/docs/understanding-roles).
10972 },
10973 ],
10974 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
10975 # prevent simultaneous updates of a policy from overwriting each other.
10976 # It is strongly suggested that systems make use of the `etag` in the
10977 # read-modify-write cycle to perform policy updates in order to avoid race
10978 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
10979 # systems are expected to put that etag in the request to `setIamPolicy` to
10980 # ensure that their change will be applied to the same version of the policy.
10981 #
10982 # **Important:** If you use IAM Conditions, you must include the `etag` field
10983 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
10984 # you to overwrite a version `3` policy with a version `1` policy, and all of
10985 # the conditions in the version `3` policy are lost.
10986 &quot;version&quot;: 42, # Specifies the format of the policy.
10987 #
10988 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
10989 # are rejected.
10990 #
10991 # Any operation that affects conditional role bindings must specify version
10992 # `3`. This requirement applies to the following operations:
10993 #
10994 # * Getting a policy that includes a conditional role binding
10995 # * Adding a conditional role binding to a policy
10996 # * Changing a conditional role binding in a policy
10997 # * Removing any role binding, with or without a condition, from a policy
10998 # that includes conditions
10999 #
11000 # **Important:** If you use IAM Conditions, you must include the `etag` field
11001 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
11002 # you to overwrite a version `3` policy with a version `1` policy, and all of
11003 # the conditions in the version `3` policy are lost.
11004 #
11005 # If a policy does not include any conditions, operations on that policy may
11006 # specify any valid version or leave the field unset.
11007 #
11008 # To learn which resources support conditions in their IAM policies, see the
11009 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
11010 },
11011 }
11012
11013 x__xgafv: string, V1 error format.
11014 Allowed values
11015 1 - v1 error format
11016 2 - v2 error format
11017
11018 Returns:
11019 An object of the form:
11020
11021 { # An Identity and Access Management (IAM) policy, which specifies access
11022 # controls for Google Cloud resources.
11023 #
11024 #
11025 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
11026 # `members`, or principals, to a single `role`. Principals can be user
11027 # accounts, service accounts, Google groups, and domains (such as G Suite). A
11028 # `role` is a named list of permissions; each `role` can be an IAM predefined
11029 # role or a user-created custom role.
11030 #
11031 # For some types of Google Cloud resources, a `binding` can also specify a
11032 # `condition`, which is a logical expression that allows access to a resource
11033 # only if the expression evaluates to `true`. A condition can add constraints
11034 # based on attributes of the request, the resource, or both. To learn which
11035 # resources support conditions in their IAM policies, see the
11036 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
11037 #
11038 # **JSON example:**
11039 #
11040 # ```
11041 # {
11042 # &quot;bindings&quot;: [
11043 # {
11044 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
11045 # &quot;members&quot;: [
11046 # &quot;user:[email protected]&quot;,
11047 # &quot;group:[email protected]&quot;,
11048 # &quot;domain:google.com&quot;,
11049 # &quot;serviceAccount:[email protected]&quot;
11050 # ]
11051 # },
11052 # {
11053 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
11054 # &quot;members&quot;: [
11055 # &quot;user:[email protected]&quot;
11056 # ],
11057 # &quot;condition&quot;: {
11058 # &quot;title&quot;: &quot;expirable access&quot;,
11059 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
11060 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
11061 # }
11062 # }
11063 # ],
11064 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
11065 # &quot;version&quot;: 3
11066 # }
11067 # ```
11068 #
11069 # **YAML example:**
11070 #
11071 # ```
11072 # bindings:
11073 # - members:
11074 # - user:[email protected]
11075 # - group:[email protected]
11076 # - domain:google.com
11077 # - serviceAccount:[email protected]
11078 # role: roles/resourcemanager.organizationAdmin
11079 # - members:
11080 # - user:[email protected]
11081 # role: roles/resourcemanager.organizationViewer
11082 # condition:
11083 # title: expirable access
11084 # description: Does not grant access after Sep 2020
11085 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
11086 # etag: BwWWja0YfJA=
11087 # version: 3
11088 # ```
11089 #
11090 # For a description of IAM and its features, see the
11091 # [IAM documentation](https://cloud.google.com/iam/docs/).
11092 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
11093 { # Specifies the audit configuration for a service.
11094 # The configuration determines which permission types are logged, and what
11095 # identities, if any, are exempted from logging.
11096 # An AuditConfig must have one or more AuditLogConfigs.
11097 #
11098 # If there are AuditConfigs for both `allServices` and a specific service,
11099 # the union of the two AuditConfigs is used for that service: the log_types
11100 # specified in each AuditConfig are enabled, and the exempted_members in each
11101 # AuditLogConfig are exempted.
11102 #
11103 # Example Policy with multiple AuditConfigs:
11104 #
11105 # {
11106 # &quot;audit_configs&quot;: [
11107 # {
11108 # &quot;service&quot;: &quot;allServices&quot;,
11109 # &quot;audit_log_configs&quot;: [
11110 # {
11111 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
11112 # &quot;exempted_members&quot;: [
11113 # &quot;user:[email protected]&quot;
11114 # ]
11115 # },
11116 # {
11117 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
11118 # },
11119 # {
11120 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
11121 # }
11122 # ]
11123 # },
11124 # {
11125 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
11126 # &quot;audit_log_configs&quot;: [
11127 # {
11128 # &quot;log_type&quot;: &quot;DATA_READ&quot;
11129 # },
11130 # {
11131 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
11132 # &quot;exempted_members&quot;: [
11133 # &quot;user:[email protected]&quot;
11134 # ]
11135 # }
11136 # ]
11137 # }
11138 # ]
11139 # }
11140 #
11141 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
11142 # logging. It also exempts `[email protected]` from DATA_READ logging, and
11143 # `[email protected]` from DATA_WRITE logging.
11144 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
11145 { # Provides the configuration for logging a type of permissions.
11146 # Example:
11147 #
11148 # {
11149 # &quot;audit_log_configs&quot;: [
11150 # {
11151 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
11152 # &quot;exempted_members&quot;: [
11153 # &quot;user:[email protected]&quot;
11154 # ]
11155 # },
11156 # {
11157 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
11158 # }
11159 # ]
11160 # }
11161 #
11162 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
11163 # [email protected] from DATA_READ logging.
11164 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
11165 # permission.
11166 # Follows the same format of Binding.members.
11167 &quot;A String&quot;,
11168 ],
11169 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
11170 },
11171 ],
11172 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
11173 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
11174 # `allServices` is a special value that covers all services.
11175 },
11176 ],
11177 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
11178 # may specify a `condition` that determines how and when the `bindings` are
11179 # applied. Each of the `bindings` must contain at least one principal.
11180 #
11181 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
11182 # of these principals can be Google groups. Each occurrence of a principal
11183 # counts towards these limits. For example, if the `bindings` grant 50
11184 # different roles to `user:[email protected]`, and not to any other
11185 # principal, then you can add another 1,450 principals to the `bindings` in
11186 # the `Policy`.
11187 { # Associates `members`, or principals, with a `role`.
11188 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
11189 #
11190 # If the condition evaluates to `true`, then this binding applies to the
11191 # current request.
11192 #
11193 # If the condition evaluates to `false`, then this binding does not apply to
11194 # the current request. However, a different role binding might grant the same
11195 # role to one or more of the principals in this binding.
11196 #
11197 # To learn which resources support conditions in their IAM policies, see the
11198 # [IAM
11199 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
11200 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
11201 # are documented at https://github.com/google/cel-spec.
11202 #
11203 # Example (Comparison):
11204 #
11205 # title: &quot;Summary size limit&quot;
11206 # description: &quot;Determines if a summary is less than 100 chars&quot;
11207 # expression: &quot;document.summary.size() &lt; 100&quot;
11208 #
11209 # Example (Equality):
11210 #
11211 # title: &quot;Requestor is owner&quot;
11212 # description: &quot;Determines if requestor is the document owner&quot;
11213 # expression: &quot;document.owner == request.auth.claims.email&quot;
11214 #
11215 # Example (Logic):
11216 #
11217 # title: &quot;Public documents&quot;
11218 # description: &quot;Determine whether the document should be publicly visible&quot;
11219 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
11220 #
11221 # Example (Data Manipulation):
11222 #
11223 # title: &quot;Notification string&quot;
11224 # description: &quot;Create a notification string with a timestamp.&quot;
11225 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
11226 #
11227 # The exact variables and functions that may be referenced within an expression
11228 # are determined by the service that evaluates it. See the service
11229 # documentation for additional information.
11230 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
11231 # describes the expression, e.g. when hovered over it in a UI.
11232 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
11233 # syntax.
11234 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
11235 # reporting, e.g. a file name and a position in the file.
11236 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
11237 # its purpose. This can be used e.g. in UIs which allow to enter the
11238 # expression.
11239 },
11240 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
11241 # `members` can have the following values:
11242 #
11243 # * `allUsers`: A special identifier that represents anyone who is
11244 # on the internet; with or without a Google account.
11245 #
11246 # * `allAuthenticatedUsers`: A special identifier that represents anyone
11247 # who is authenticated with a Google account or a service account.
11248 # Does not include identities that come from external identity providers
11249 # (IdPs) through identity federation.
11250 #
11251 # * `user:{emailid}`: An email address that represents a specific Google
11252 # account. For example, `[email protected]` .
11253 #
11254 #
11255 # * `serviceAccount:{emailid}`: An email address that represents a Google
11256 # service account. For example,
11257 # `[email protected]`.
11258 #
11259 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
11260 # identifier for a
11261 # [Kubernetes service
11262 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
11263 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
11264 #
11265 # * `group:{emailid}`: An email address that represents a Google group.
11266 # For example, `[email protected]`.
11267 #
11268 #
11269 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
11270 # users of that domain. For example, `google.com` or `example.com`.
11271 #
11272 #
11273 #
11274 #
11275 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
11276 # A single identity in a workforce identity pool.
11277 #
11278 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
11279 # All workforce identities in a group.
11280 #
11281 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
11282 # All workforce identities with a specific attribute value.
11283 #
11284 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
11285 # All identities in a workforce identity pool.
11286 #
11287 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
11288 # A single identity in a workload identity pool.
11289 #
11290 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
11291 # A workload identity pool group.
11292 #
11293 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
11294 # All identities in a workload identity pool with a certain attribute.
11295 #
11296 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
11297 # All identities in a workload identity pool.
11298 #
11299 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
11300 # identifier) representing a user that has been recently deleted. For
11301 # example, `[email protected]?uid=123456789012345678901`. If the user is
11302 # recovered, this value reverts to `user:{emailid}` and the recovered user
11303 # retains the role in the binding.
11304 #
11305 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
11306 # unique identifier) representing a service account that has been recently
11307 # deleted. For example,
11308 # `[email protected]?uid=123456789012345678901`.
11309 # If the service account is undeleted, this value reverts to
11310 # `serviceAccount:{emailid}` and the undeleted service account retains the
11311 # role in the binding.
11312 #
11313 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
11314 # identifier) representing a Google group that has been recently
11315 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
11316 # the group is recovered, this value reverts to `group:{emailid}` and the
11317 # recovered group retains the role in the binding.
11318 #
11319 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
11320 # Deleted single identity in a workforce identity pool. For example,
11321 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
11322 &quot;A String&quot;,
11323 ],
11324 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
11325 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
11326 #
11327 # For an overview of the IAM roles and permissions, see the
11328 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
11329 # a list of the available pre-defined roles, see
11330 # [here](https://cloud.google.com/iam/docs/understanding-roles).
11331 },
11332 ],
11333 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
11334 # prevent simultaneous updates of a policy from overwriting each other.
11335 # It is strongly suggested that systems make use of the `etag` in the
11336 # read-modify-write cycle to perform policy updates in order to avoid race
11337 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
11338 # systems are expected to put that etag in the request to `setIamPolicy` to
11339 # ensure that their change will be applied to the same version of the policy.
11340 #
11341 # **Important:** If you use IAM Conditions, you must include the `etag` field
11342 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
11343 # you to overwrite a version `3` policy with a version `1` policy, and all of
11344 # the conditions in the version `3` policy are lost.
11345 &quot;version&quot;: 42, # Specifies the format of the policy.
11346 #
11347 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
11348 # are rejected.
11349 #
11350 # Any operation that affects conditional role bindings must specify version
11351 # `3`. This requirement applies to the following operations:
11352 #
11353 # * Getting a policy that includes a conditional role binding
11354 # * Adding a conditional role binding to a policy
11355 # * Changing a conditional role binding in a policy
11356 # * Removing any role binding, with or without a condition, from a policy
11357 # that includes conditions
11358 #
11359 # **Important:** If you use IAM Conditions, you must include the `etag` field
11360 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
11361 # you to overwrite a version `3` policy with a version `1` policy, and all of
11362 # the conditions in the version `3` policy are lost.
11363 #
11364 # If a policy does not include any conditions, operations on that policy may
11365 # specify any valid version or leave the field unset.
11366 #
11367 # To learn which resources support conditions in their IAM policies, see the
11368 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
11369 }</pre>
11370 </div>
11371
11372 <div class="method">
11373 <code class="details" id="setSecurityPolicy">setSecurityPolicy(project, backendService, body=None, requestId=None, x__xgafv=None)</code>
11374 <pre>Sets the Google Cloud Armor security policy for the specified backend
11375 service. For more information, seeGoogle
11376 Cloud Armor Overview
11377
11378 Args:
11379 project: string, Project ID for this request. (required)
11380 backendService: string, Name of the BackendService resource to which the security policy should be
11381 set. The name should conform to RFC1035. (required)
11382 body: object, The request body.
11383 The object takes the form of:
11384
11385 {
11386 &quot;securityPolicy&quot;: &quot;A String&quot;,
11387 }
11388
11389 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
11390 that if you must retry your request, the server will know to ignore the
11391 request if it has already been completed.
11392
11393 For example, consider a situation where you make an initial request and
11394 the request times out. If you make the request again with the same
11395 request ID, the server can check if original operation with the same
11396 request ID was received, and if so, will ignore the second request. This
11397 prevents clients from accidentally creating duplicate commitments.
11398
11399 The request ID must be
11400 a valid UUID with the exception that zero UUID is not supported
11401 (00000000-0000-0000-0000-000000000000).
11402 x__xgafv: string, V1 error format.
11403 Allowed values
11404 1 - v1 error format
11405 2 - v2 error format
11406
11407 Returns:
11408 An object of the form:
11409
11410 { # Represents an Operation resource.
11411 #
11412 # Google Compute Engine has three Operation resources:
11413 #
11414 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
11415 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
11416 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
11417 #
11418 # You can use an operation resource to manage asynchronous API requests.
11419 # For more information, readHandling
11420 # API responses.
11421 #
11422 # Operations can be global, regional or zonal.
11423 #
11424 # - For global operations, use the `globalOperations`
11425 # resource.
11426 # - For regional operations, use the
11427 # `regionOperations` resource.
11428 # - For zonal operations, use
11429 # the `zoneOperations` resource.
11430 #
11431 #
11432 #
11433 # For more information, read
11434 # Global, Regional, and Zonal Resources.
11435 #
11436 # Note that completed Operation resources have a limited
11437 # retention period.
11438 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
11439 # Not present otherwise.
11440 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
11441 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
11442 # set when the operation is created.
11443 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
11444 # text format.
11445 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
11446 # this field will be populated.
11447 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
11448 # operation.
11449 {
11450 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
11451 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
11452 # details. There is a set of defined message types to use for providing
11453 # details.The syntax depends on the error code. For example,
11454 # QuotaExceededInfo will have details when the error code is
11455 # QUOTA_EXCEEDED.
11456 {
11457 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
11458 #
11459 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
11460 # is not enabled:
11461 #
11462 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
11463 # &quot;domain&quot;: &quot;googleapis.com&quot;
11464 # &quot;metadata&quot;: {
11465 # &quot;resource&quot;: &quot;projects/123&quot;,
11466 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
11467 # }
11468 # }
11469 #
11470 # This response indicates that the pubsub.googleapis.com API is not enabled.
11471 #
11472 # Example of an error that is returned when attempting to create a Spanner
11473 # instance in a region that is out of stock:
11474 #
11475 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
11476 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
11477 # &quot;metadata&quot;: {
11478 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
11479 # }
11480 # }
11481 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
11482 # is typically the registered service name of the tool or product that
11483 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
11484 # generated by some common infrastructure, the error domain must be a
11485 # globally unique value that identifies the infrastructure. For Google API
11486 # infrastructure, the error domain is &quot;googleapis.com&quot;.
11487 &quot;metadatas&quot;: { # Additional structured details about this error.
11488 #
11489 # Keys must match a regular expression of `a-z+` but should
11490 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
11491 # length. When identifying the current value of an exceeded limit, the units
11492 # should be contained in the key, not the value. For example, rather than
11493 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
11494 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
11495 # instances that can be created in a single (batch) request.
11496 &quot;a_key&quot;: &quot;A String&quot;,
11497 },
11498 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
11499 # proximate cause of the error. Error reasons are unique within a particular
11500 # domain of errors. This should be at most 63 characters and match a
11501 # regular expression of `A-Z+[A-Z0-9]`, which represents
11502 # UPPER_SNAKE_CASE.
11503 },
11504 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
11505 #
11506 # For example, if a quota check failed with an error indicating the calling
11507 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
11508 # directly to the right place in the developer console to flip the bit.
11509 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
11510 { # Describes a URL link.
11511 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
11512 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
11513 },
11514 ],
11515 },
11516 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
11517 # which can be attached to an RPC error.
11518 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
11519 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
11520 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
11521 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
11522 },
11523 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
11524 &quot;dimensions&quot;: { # The map holding related quota dimensions.
11525 &quot;a_key&quot;: &quot;A String&quot;,
11526 },
11527 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
11528 # type or metric.
11529 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
11530 # or metric.
11531 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
11532 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
11533 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
11534 },
11535 },
11536 ],
11537 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
11538 # This property is optional.
11539 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
11540 },
11541 ],
11542 },
11543 &quot;getVersionOperationMetadata&quot;: {
11544 &quot;inlineSbomInfo&quot;: {
11545 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
11546 # appropriate identifiers.
11547 &quot;a_key&quot;: &quot;A String&quot;,
11548 },
11549 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
11550 # identifiers.
11551 &quot;a_key&quot;: &quot;A String&quot;,
11552 },
11553 },
11554 },
11555 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
11556 # message that was returned, such as `NOT FOUND`.
11557 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
11558 # status code that was returned. For example, a `404` means the
11559 # resource was not found.
11560 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
11561 # defined by the server.
11562 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
11563 # This value is inRFC3339
11564 # text format.
11565 &quot;instancesBulkInsertOperationMetadata&quot;: {
11566 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
11567 # Example key: zones/us-central1-a
11568 &quot;a_key&quot;: {
11569 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
11570 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
11571 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
11572 # error.
11573 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
11574 # if the flow is rolling forward or rolling back.
11575 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
11576 },
11577 },
11578 },
11579 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
11580 # Operation resources.
11581 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
11582 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
11583 # group of operations results from a `bulkInsert` API request.
11584 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
11585 # `update`, or `delete`, and so on.
11586 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
11587 # There is no requirement that this be linear or support any granularity of
11588 # operations. This should not be used to guess when the operation will be
11589 # complete. This number should monotonically increase as the operation
11590 # progresses.
11591 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
11592 # applicable when performing regional operations.
11593 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
11594 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
11595 # this field will contain information on all underlying zonal actions and
11596 # their state.
11597 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
11598 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
11599 # Example key: zones/us-central1-a
11600 &quot;a_key&quot;: {
11601 &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
11602 # populated.
11603 # different programming environments, including REST APIs and RPC APIs. It is
11604 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
11605 # three pieces of data: error code, error message, and error details.
11606 #
11607 # You can find out more about this error model and how to work with it in the
11608 # [API Design Guide](https://cloud.google.com/apis/design/errors).
11609 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
11610 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
11611 # message types for APIs to use.
11612 {
11613 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
11614 },
11615 ],
11616 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
11617 # user-facing error message should be localized and sent in the
11618 # google.rpc.Status.details field, or localized by the client.
11619 },
11620 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
11621 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
11622 },
11623 },
11624 },
11625 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
11626 # This value is inRFC3339
11627 # text format.
11628 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
11629 # following:
11630 # `PENDING`, `RUNNING`, or `DONE`.
11631 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
11632 # operation.
11633 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
11634 # of the target resource.
11635 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
11636 # operations related to creating a snapshot, this points to the disk
11637 # that the snapshot was created from.
11638 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
11639 # `[email protected]` or
11640 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
11641 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
11642 # operation, this field will be populated.
11643 {
11644 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
11645 # Engine returns NO_RESULTS_ON_PAGE if there
11646 # are no results in the response.
11647 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
11648 # value format. For example:
11649 #
11650 # &quot;data&quot;: [
11651 # {
11652 # &quot;key&quot;: &quot;scope&quot;,
11653 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
11654 # }
11655 {
11656 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
11657 # returned. For example, for warnings where there are no results in a list
11658 # request for a particular zone, this key might be scope and
11659 # the key value might be the zone name. Other examples might be a key
11660 # indicating a deprecated resource and a suggested replacement, or a
11661 # warning about invalid network settings (for example, if an instance
11662 # attempts to perform IP forwarding but is not enabled for IP forwarding).
11663 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
11664 },
11665 ],
11666 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
11667 },
11668 ],
11669 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
11670 # applicable when performing per-zone operations.
11671 }</pre>
11672 </div>
11673
11674 <div class="method">
11675 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code>
11676 <pre>Returns permissions that a caller has on the specified resource.
11677
11678 Args:
11679 project: string, Project ID for this request. (required)
11680 resource: string, Name or id of the resource for this request. (required)
11681 body: object, The request body.
11682 The object takes the form of:
11683
11684 {
11685 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
11686 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
11687 &quot;A String&quot;,
11688 ],
11689 }
11690
11691 x__xgafv: string, V1 error format.
11692 Allowed values
11693 1 - v1 error format
11694 2 - v2 error format
11695
11696 Returns:
11697 An object of the form:
11698
11699 {
11700 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
11701 # allowed.
11702 &quot;A String&quot;,
11703 ],
11704 }</pre>
11705 </div>
11706
11707 <div class="method">
11708 <code class="details" id="update">update(project, backendService, body=None, requestId=None, x__xgafv=None)</code>
11709 <pre>Updates the specified BackendService resource with the data included in the
11710 request. For more information, seeBackend
11711 services overview.
11712
11713 Args:
11714 project: string, Project ID for this request. (required)
11715 backendService: string, Name of the BackendService resource to update. (required)
11716 body: object, The request body.
11717 The object takes the form of:
11718
11719 { # Represents a Backend Service resource.
11720 #
11721 # A backend service defines how Google Cloud load balancers distribute traffic.
11722 # The backend service configuration contains a set of values, such as the
11723 # protocol used to connect to backends, various distribution and session
11724 # settings, health checks, and timeouts. These settings provide fine-grained
11725 # control over how your load balancer behaves. Most of the settings have
11726 # default values that allow for easy configuration if you need to get started
11727 # quickly.
11728 #
11729 # Backend services in Google Compute Engine can be either regionally or
11730 # globally scoped.
11731 #
11732 # * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices)
11733 # * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices)
11734 #
11735 # For more information, seeBackend
11736 # Services.
11737 &quot;affinityCookieTtlSec&quot;: 42, # Lifetime of cookies in seconds. This setting is applicable to Application
11738 # Load Balancers and Traffic Director and requires
11739 # GENERATED_COOKIE or HTTP_COOKIE session affinity.
11740 #
11741 # If set to 0, the cookie is non-persistent and lasts only until
11742 # the end of the browser session (or equivalent). The maximum allowed value
11743 # is two weeks (1,209,600).
11744 #
11745 # Not supported when the backend service is referenced by a URL map that is
11746 # bound to target gRPC proxy that has validateForProxyless field set to true.
11747 &quot;backends&quot;: [ # The list of backends that serve this BackendService.
11748 { # Message containing information of one individual backend.
11749 &quot;balancingMode&quot;: &quot;A String&quot;, # Specifies how to determine whether the backend of a load balancer can
11750 # handle additional traffic or is fully loaded. For usage guidelines, see
11751 # Connection balancing mode.
11752 #
11753 # Backends must use compatible balancing modes. For more information, see
11754 # Supported balancing modes and target capacity settings and
11755 # Restrictions and guidance for instance groups.
11756 #
11757 # Note: Currently, if you use the API to configure incompatible balancing
11758 # modes, the configuration might be accepted even though it has no impact
11759 # and is ignored. Specifically, Backend.maxUtilization is ignored when
11760 # Backend.balancingMode is RATE. In the future, this incompatible combination
11761 # will be rejected.
11762 &quot;capacityScaler&quot;: 3.14, # A multiplier applied to the backend&#x27;s target capacity of its balancing
11763 # mode.
11764 # The default value is 1, which means the group serves up to
11765 # 100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is
11766 # completely drained, offering 0% of its available capacity. The valid ranges
11767 # are 0.0 and [0.1,1.0].
11768 # You cannot configure a setting larger than 0 and smaller than0.1.
11769 # You cannot configure a setting of 0 when there is only one
11770 # backend attached to the backend service.
11771 #
11772 # Not available with backends that don&#x27;t support using abalancingMode. This includes backends such as global
11773 # internet NEGs, regional serverless NEGs, and PSC NEGs.
11774 &quot;customMetrics&quot;: [ # List of custom metrics that are used for CUSTOM_METRICS
11775 # BalancingMode.
11776 { # Custom Metrics are used for CUSTOM_METRICS balancing_mode.
11777 &quot;dryRun&quot;: True or False, # If true, the metric data is collected and reported to Cloud
11778 # Monitoring, but is not used for load balancing.
11779 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target utilization for the Custom Metrics
11780 # balancing mode. The valid range is [0.0, 1.0].
11781 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
11782 # long and match the regular expression
11783 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
11784 # first character must be a lowercase letter, and all following
11785 # characters must be a dash, period, underscore, lowercase letter, or
11786 # digit, except the last character, which cannot be a dash, period, or
11787 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
11788 # field can only be used for a global or regional backend service with the
11789 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
11790 },
11791 ],
11792 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
11793 # create the resource.
11794 &quot;failover&quot;: True or False, # This field designates whether this is a failover backend. More than one
11795 # failover backend can be configured for a given BackendService.
11796 &quot;group&quot;: &quot;A String&quot;, # The fully-qualified URL of aninstance
11797 # group or network endpoint
11798 # group (NEG) resource. To determine what types of backends a load
11799 # balancer supports, see the [Backend services
11800 # overview](https://cloud.google.com/load-balancing/docs/backend-service#backends).
11801 #
11802 # You must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group
11803 # or NEG. Partial URLs are not supported.
11804 #
11805 # If haPolicy is specified, backends must refer to NEG resources of type
11806 # GCE_VM_IP.
11807 &quot;maxConnections&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
11808 # guidelines, seeConnection
11809 # balancing mode and Utilization
11810 # balancing mode. Not available if the backend&#x27;sbalancingMode is RATE.
11811 &quot;maxConnectionsPerEndpoint&quot;: 42, # Defines a target maximum number of simultaneous connections. For usage
11812 # guidelines, seeConnection
11813 # balancing mode and Utilization
11814 # balancing mode.
11815 #
11816 # Not available if the backend&#x27;s balancingMode isRATE.
11817 &quot;maxConnectionsPerInstance&quot;: 42, # Defines a target maximum number of simultaneous connections.
11818 # For usage guidelines, seeConnection
11819 # balancing mode and Utilization
11820 # balancing mode.
11821 #
11822 # Not available if the backend&#x27;s balancingMode isRATE.
11823 &quot;maxInFlightRequests&quot;: 42, # Defines a maximum number of in-flight requests for the whole NEG or
11824 # instance group. Not available if backend&#x27;s balancingMode isRATE or CONNECTION.
11825 &quot;maxInFlightRequestsPerEndpoint&quot;: 42, # Defines a maximum number of in-flight requests for a single endpoint.
11826 # Not available if backend&#x27;s balancingMode is RATE
11827 # or CONNECTION.
11828 &quot;maxInFlightRequestsPerInstance&quot;: 42, # Defines a maximum number of in-flight requests for a single VM.
11829 # Not available if backend&#x27;s balancingMode is RATE
11830 # or CONNECTION.
11831 &quot;maxRate&quot;: 42, # Defines a maximum number of HTTP requests per second (RPS). For
11832 # usage guidelines, seeRate
11833 # balancing mode and Utilization
11834 # balancing mode.
11835 #
11836 # Not available if the backend&#x27;s balancingMode isCONNECTION.
11837 &quot;maxRatePerEndpoint&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
11838 # guidelines, seeRate
11839 # balancing mode and Utilization
11840 # balancing mode.
11841 #
11842 # Not available if the backend&#x27;s balancingMode isCONNECTION.
11843 &quot;maxRatePerInstance&quot;: 3.14, # Defines a maximum target for requests per second (RPS). For usage
11844 # guidelines, seeRate
11845 # balancing mode and Utilization
11846 # balancing mode.
11847 #
11848 # Not available if the backend&#x27;s balancingMode isCONNECTION.
11849 &quot;maxUtilization&quot;: 3.14, # Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].
11850 #
11851 # For usage guidelines, seeUtilization
11852 # balancing mode.
11853 &quot;orchestrationInfo&quot;: { # A message containing information about the resource or system that manages # Information about the resource or system that manages the backend.
11854 # the backend.
11855 &quot;resourceUri&quot;: &quot;A String&quot;, # The URI of the resource or system that manages the backend.
11856 },
11857 &quot;preference&quot;: &quot;A String&quot;, # This field indicates whether this backend should be fully utilized before
11858 # sending traffic to backends with default preference. The possible values
11859 # are:
11860 #
11861 # - PREFERRED: Backends with this preference level will be
11862 # filled up to their capacity limits first, based on RTT.
11863 # - DEFAULT: If preferred backends don&#x27;t have enough
11864 # capacity, backends in this layer would be used and traffic would be
11865 # assigned based on the load balancing algorithm you use. This is the
11866 # default
11867 &quot;trafficDuration&quot;: &quot;A String&quot;,
11868 },
11869 ],
11870 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend service. # Cloud CDN configuration for this BackendService. Only available for
11871 # specified load balancer types.
11872 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
11873 # Pragma or Authorization headers. Up to 5 headers can be specified.
11874 # The cache is bypassed for all cdnPolicy.cacheMode settings.
11875 { # Bypass the cache when the specified request headers are present,
11876 # e.g. Pragma or Authorization headers. Values are case insensitive.
11877 # The presence of such a header overrides the cache_mode setting.
11878 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
11879 # Values are case-insensitive.
11880 },
11881 ],
11882 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for Cloud # The CacheKeyPolicy for this CdnPolicy.
11883 # CDN.
11884 &quot;includeHost&quot;: True or False, # If true, requests to different hosts will be cached separately.
11885 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
11886 &quot;A String&quot;,
11887 ],
11888 &quot;includeNamedCookies&quot;: [ # Allows HTTP cookies (by name) to be used in the cache key.
11889 # The name=value pair will be used in the cache key Cloud CDN generates.
11890 &quot;A String&quot;,
11891 ],
11892 &quot;includeProtocol&quot;: True or False, # If true, http and https requests will be cached separately.
11893 &quot;includeQueryString&quot;: True or False, # If true, include query string parameters in the cache key according to
11894 # query_string_whitelist and query_string_blacklist. If neither is set, the
11895 # entire query string will be included. If false, the query string will be
11896 # excluded from the cache key entirely.
11897 &quot;queryStringBlacklist&quot;: [ # Names of query string parameters to exclude in cache keys. All other
11898 # parameters will be included. Either specify query_string_whitelist or
11899 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
11900 # not treated as delimiters.
11901 &quot;A String&quot;,
11902 ],
11903 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. All other
11904 # parameters will be excluded. Either specify query_string_whitelist or
11905 # query_string_blacklist, not both. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded and
11906 # not treated as delimiters.
11907 &quot;A String&quot;,
11908 ],
11909 },
11910 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
11911 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
11912 # headers to cache content. Responses without these headers will not be
11913 # cached at Google&#x27;s edge, and will require a full trip to the origin on
11914 # every request, potentially impacting performance and increasing load on
11915 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
11916 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
11917 # Warning: this may result in Cloud CDN caching private,
11918 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
11919 # including common image formats, media (video and audio), and web assets
11920 # (JavaScript and CSS). Requests and responses that are marked as
11921 # uncacheable, as well as dynamic content (including HTML), will not be
11922 # cached.
11923 #
11924 # If no value is provided for cdnPolicy.cacheMode, it defaults
11925 # to CACHE_ALL_STATIC.
11926 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
11927 # used to clamp the max-age (or Expires) value sent to the client. With
11928 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
11929 # response max-age directive, along with a &quot;public&quot; directive. For
11930 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
11931 # from the origin (if specified), or else sets the response max-age
11932 # directive to the lesser of the client_ttl and default_ttl, and also
11933 # ensures a &quot;public&quot; cache-control directive is present.
11934 # If a client TTL is not specified, a default value (1 hour) will be used.
11935 # The maximum allowed value is 31,622,400s (1 year).
11936 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
11937 # responses that do not have an existing valid TTL (max-age or s-maxage).
11938 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
11939 # The value of defaultTTL cannot be set to a value greater than that of
11940 # maxTTL, but can be equal.
11941 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
11942 # will overwrite the TTL set in all responses. The maximum allowed value is
11943 # 31,622,400s (1 year), noting that infrequently accessed objects may be
11944 # evicted from the cache before the defined TTL.
11945 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
11946 # origin.
11947 # Cache directives that attempt to set a max-age or s-maxage higher than
11948 # this, or an Expires header more than maxTTL seconds in the future will
11949 # be capped at the value of maxTTL, as if it were the value of an
11950 # s-maxage Cache-Control directive.
11951 # Headers sent to the client will not be modified.
11952 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
11953 # The maximum allowed value is 31,622,400s (1 year), noting that
11954 # infrequently accessed objects may be evicted from the cache before
11955 # the defined TTL.
11956 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
11957 # to apply fine-grained caching for common errors or redirects.
11958 # This can reduce the load on your origin and improve end-user
11959 # experience by reducing response latency.
11960 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
11961 # negative caching applies to responses with the specified response code
11962 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
11963 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
11964 # to all responses with the specified response code, and override any
11965 # caching headers.
11966 # By default, Cloud CDN will apply the following default TTLs to these
11967 # status codes:
11968 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
11969 # HTTP 404 (Not Found), 410 (Gone),
11970 # 451 (Unavailable For Legal Reasons): 120s
11971 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
11972 # These defaults can be overridden in negative_caching_policy.
11973 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
11974 # negative_caching must be enabled to configure negative_caching_policy.
11975 # Omitting the policy and leaving negative_caching enabled will use
11976 # Cloud CDN&#x27;s default cache TTLs.
11977 # Note that when specifying an explicit negative_caching_policy, you
11978 # should take care to specify a cache TTL for all response codes
11979 # that you wish to cache. Cloud CDN will not apply any default
11980 # negative caching when a policy exists.
11981 { # Specify CDN TTLs for response error codes.
11982 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
11983 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
11984 # specified as values, and you cannot specify a status code more than
11985 # once.
11986 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
11987 # corresponding status code.
11988 # The maximum allowed value is 1800s (30 minutes), noting that
11989 # infrequently accessed objects may be evicted from the cache before the
11990 # defined TTL.
11991 },
11992 ],
11993 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
11994 # requests into a small number of requests to the origin.
11995 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
11996 # content with the origin, or when an error is encountered when refreshing
11997 # the cache.
11998 # This setting defines the default &quot;max-stale&quot; duration for any cached
11999 # responses that do not specify a max-stale directive. Stale responses that
12000 # exceed the TTL configured here will not be served. The default limit
12001 # (max-stale) is 86400s (1 day), which will allow stale content to be
12002 # served up to this limit beyond the max-age (or s-maxage) of a cached
12003 # response.
12004 # The maximum allowed value is 604800 (1 week).
12005 # Set this to zero (0) to disable serve-while-stale.
12006 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
12007 # considered fresh. After this time period, the response will be
12008 # revalidated before being served. Defaults to 1hr (3600s). When serving
12009 # responses to signed URL requests, Cloud CDN will internally behave as
12010 # though all responses from this backend had a &quot;Cache-Control:
12011 # public, max-age=[TTL]&quot; header, regardless of any existing
12012 # Cache-Control header. The actual headers served in responses will not be
12013 # altered.
12014 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
12015 &quot;A String&quot;,
12016 ],
12017 },
12018 &quot;circuitBreakers&quot;: { # Settings controlling the volume of requests, connections and retries to this
12019 # backend service.
12020 &quot;maxConnections&quot;: 42, # The maximum number of connections to the backend service. If not specified,
12021 # there is no limit.
12022 #
12023 # Not supported when the backend service is referenced by a URL map that is
12024 # bound to target gRPC proxy that has validateForProxyless field set to true.
12025 &quot;maxPendingRequests&quot;: 42, # The maximum number of pending requests allowed to the backend service. If
12026 # not specified, there is no limit.
12027 #
12028 # Not supported when the backend service is referenced by a URL map that is
12029 # bound to target gRPC proxy that has validateForProxyless field set to true.
12030 &quot;maxRequests&quot;: 42, # The maximum number of parallel requests that allowed to the backend
12031 # service. If not specified, there is no limit.
12032 &quot;maxRequestsPerConnection&quot;: 42, # Maximum requests for a single connection to the backend service.
12033 # This parameter is respected by both the HTTP/1.1 and HTTP/2
12034 # implementations. If not specified, there is no limit. Setting this
12035 # parameter to 1 will effectively disable keep alive.
12036 #
12037 # Not supported when the backend service is referenced by a URL map that is
12038 # bound to target gRPC proxy that has validateForProxyless field set to true.
12039 &quot;maxRetries&quot;: 42, # The maximum number of parallel retries allowed to the backend cluster. If
12040 # not specified, the default is 1.
12041 #
12042 # Not supported when the backend service is referenced by a URL map that is
12043 # bound to target gRPC proxy that has validateForProxyless field set to true.
12044 },
12045 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
12046 # the client&#x27;s Accept-Encoding header.
12047 &quot;connectionDraining&quot;: { # Message containing connection draining configuration. # connectionDraining cannot be specified with haPolicy.
12048 &quot;drainingTimeoutSec&quot;: 42, # Configures a duration timeout for existing requests on a removed backend
12049 # instance. For supported load balancers and protocols, as described inEnabling
12050 # connection draining.
12051 },
12052 &quot;connectionTrackingPolicy&quot;: { # Connection Tracking configuration for this BackendService. # Connection Tracking configuration for this BackendService. Connection
12053 # tracking policy settings are only available for external passthrough
12054 # Network Load Balancers and internal passthrough Network Load Balancers.
12055 #
12056 # connectionTrackingPolicy cannot be specified with haPolicy.
12057 &quot;connectionPersistenceOnUnhealthyBackends&quot;: &quot;A String&quot;, # Specifies connection persistence when backends are unhealthy. The default
12058 # value is DEFAULT_FOR_PROTOCOL.
12059 #
12060 # If set to DEFAULT_FOR_PROTOCOL, the existing connections
12061 # persist on unhealthy backends only for connection-oriented protocols
12062 # (TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session
12063 # Affinity is configured for 5-tuple. They do not persist forUDP.
12064 #
12065 # If set to NEVER_PERSIST, after a backend becomes unhealthy,
12066 # the existing connections on the unhealthy backend are never persisted on
12067 # the unhealthy backend. They are always diverted to newly selected healthy
12068 # backends (unless all backends are unhealthy).
12069 #
12070 # If set to ALWAYS_PERSIST, existing connections always
12071 # persist on unhealthy backends regardless of protocol and session
12072 # affinity. It is generally not recommended to use this mode overriding the
12073 # default.
12074 #
12075 # For more details, see [Connection Persistence for Network Load
12076 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)
12077 # and [Connection Persistence for Internal TCP/UDP Load
12078 # Balancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).
12079 &quot;enableStrongAffinity&quot;: True or False, # Enable Strong Session Affinity for external passthrough Network Load
12080 # Balancers. This option is not available publicly.
12081 &quot;idleTimeoutSec&quot;: 42, # Specifies how long to keep a Connection Tracking entry while there is no
12082 # matching traffic (in seconds).
12083 #
12084 # For internal passthrough Network Load Balancers:
12085 #
12086 # - The minimum (default) is 10 minutes and the maximum is 16 hours.
12087 # - It can be set only if Connection Tracking is less than 5-tuple
12088 # (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking
12089 # Mode is PER_SESSION).
12090 #
12091 #
12092 #
12093 # For external passthrough Network Load Balancers the default is 60
12094 # seconds. This option is not available publicly.
12095 &quot;trackingMode&quot;: &quot;A String&quot;, # Specifies the key used for connection tracking. There are two
12096 # options:
12097 #
12098 # - PER_CONNECTION: This is the default mode. The Connection
12099 # Tracking is performed as per the Connection Key (default Hash Method) for
12100 # the specific protocol.
12101 # - PER_SESSION: The Connection Tracking is performed as per
12102 # the configured Session Affinity. It matches the configured Session
12103 # Affinity.
12104 #
12105 #
12106 #
12107 # For more details, see [Tracking Mode for Network Load
12108 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)
12109 # and [Tracking Mode for Internal TCP/UDP Load
12110 # Balancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).
12111 },
12112 &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
12113 # affinity based on HTTP headers, cookies or other properties. This load
12114 # balancing policy is applicable only for HTTP connections. The affinity to a
12115 # particular destination host will be lost when one or more hosts are
12116 # added/removed from the destination service. This field specifies parameters
12117 # that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.
12118 #
12119 # This field is applicable to either:
12120 #
12121 # - A regional backend service with the service protocol set to HTTP,
12122 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
12123 # INTERNAL_MANAGED.
12124 # - A global backend service with the
12125 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
12126 &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
12127 # be used as the hash key for the consistent hash load balancer. If the
12128 # cookie is not present, it will be generated. This field is applicable if
12129 # the sessionAffinity is set to HTTP_COOKIE.
12130 #
12131 # Not supported when the backend service is referenced by a URL map that is
12132 # bound to target gRPC proxy that has validateForProxyless field set to true.
12133 # for load balancing policies that use a consistent hash.
12134 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
12135 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
12136 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
12137 # as a count of seconds and fractions of seconds at nanosecond
12138 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
12139 # or &quot;month&quot;. Range is approximately 10,000 years.
12140 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
12141 # Durations less than one second are represented with a 0
12142 # `seconds` field and a positive `nanos` field. Must be from 0
12143 # to 999,999,999 inclusive.
12144 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
12145 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
12146 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
12147 },
12148 },
12149 &quot;httpHeaderName&quot;: &quot;A String&quot;, # The hash based on the value of the specified header field. This field is
12150 # applicable if the sessionAffinity is set toHEADER_FIELD.
12151 &quot;minimumRingSize&quot;: &quot;A String&quot;, # The minimum number of virtual nodes to use for the hash ring. Defaults to
12152 # 1024. Larger ring sizes result in more granular load distributions. If the
12153 # number of hosts in the load balancing pool is larger than the ring size,
12154 # each host will be assigned a single virtual node.
12155 },
12156 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
12157 # text format.
12158 &quot;customMetrics&quot;: [ # List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
12159 { # Custom Metrics are used for WEIGHTED_ROUND_ROBIN
12160 # locality_lb_policy.
12161 &quot;dryRun&quot;: True or False, # If true, the metric data is not used for load balancing.
12162 &quot;name&quot;: &quot;A String&quot;, # Name of a custom utilization signal. The name must be 1-64 characters
12163 # long and match the regular expression
12164 # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
12165 # first character must be a lowercase letter, and all following
12166 # characters must be a dash, period, underscore, lowercase letter, or
12167 # digit, except the last character, which cannot be a dash, period, or
12168 # underscore. For usage guidelines, see Custom Metrics balancing mode. This
12169 # field can only be used for a global or regional backend service with the
12170 # loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.
12171 },
12172 ],
12173 &quot;customRequestHeaders&quot;: [ # Headers that the load balancer adds to proxied requests. See [Creating
12174 # custom
12175 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
12176 &quot;A String&quot;,
12177 ],
12178 &quot;customResponseHeaders&quot;: [ # Headers that the load balancer adds to proxied responses. See [Creating
12179 # custom
12180 # headers](https://cloud.google.com/load-balancing/docs/custom-headers).
12181 &quot;A String&quot;,
12182 ],
12183 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
12184 # create the resource.
12185 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
12186 # this backend service.
12187 &quot;enableCDN&quot;: True or False, # If true, enables Cloud CDN for the backend service of a
12188 # global external Application Load Balancer.
12189 &quot;externalManagedMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state. Possible values are PREPARE,
12190 # TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.
12191 #
12192 # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
12193 # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
12194 # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
12195 # TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using
12196 # externalManagedMigrationTestingPercentage.
12197 #
12198 # Rolling back a migration requires the states to be set in reverse order. So
12199 # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
12200 # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
12201 # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
12202 # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
12203 &quot;externalManagedMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests that should be processed by the Global
12204 # external Application Load Balancer.
12205 #
12206 # The value of this field must be in the range [0, 100].
12207 #
12208 # Session affinity options will slightly affect this routing behavior, for
12209 # more details, see:Session
12210 # Affinity.
12211 #
12212 # This value can only be set if the loadBalancingScheme in the BackendService
12213 # is set to EXTERNAL (when using the classic Application Load Balancer) and
12214 # the migration state is TEST_BY_PERCENTAGE.
12215 &quot;failoverPolicy&quot;: { # For load balancers that have configurable # Requires at least one backend instance group to be defined
12216 # as a backup (failover) backend.
12217 # For load balancers that have configurable failover:
12218 # [Internal passthrough Network Load
12219 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
12220 # and [external passthrough Network Load
12221 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
12222 #
12223 # failoverPolicy cannot be specified with haPolicy.
12224 # failover:
12225 # [Internal passthrough Network Load
12226 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
12227 # and [external passthrough
12228 # Network Load
12229 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
12230 # On failover or failback, this field indicates whether connection draining
12231 # will be honored. Google Cloud has a fixed connection draining timeout of
12232 # 10 minutes. A setting of true terminates existing TCP
12233 # connections to the active pool during failover and failback, immediately
12234 # draining traffic. A setting of false allows existing TCP
12235 # connections to persist, even on VMs no longer in the active pool, for up
12236 # to the duration of the connection draining timeout (10 minutes).
12237 &quot;disableConnectionDrainOnFailover&quot;: True or False, # This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.
12238 #
12239 # The default is false.
12240 &quot;dropTrafficIfUnhealthy&quot;: True or False, # If set to true, connections to the
12241 # load balancer are dropped when all primary and all backup backend VMs are
12242 # unhealthy.If set to false, connections are distributed
12243 # among all primary VMs when all primary and all backup backend VMs are
12244 # unhealthy.
12245 # For load balancers that have configurable
12246 # failover:
12247 # [Internal passthrough
12248 # Network Load
12249 # Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
12250 # and [external passthrough
12251 # Network Load
12252 # Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
12253 # The default is false.
12254 &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
12255 # failover when the number of healthy primary VMs equals zero.
12256 # For all other values, the load balancer performs a failover when the
12257 # total number of healthy primary VMs is less than this ratio.
12258 # For load balancers that have configurable
12259 # failover:
12260 # [Internal TCP/UDP Load
12261 # Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)
12262 # and [external TCP/UDP Load
12263 # Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
12264 },
12265 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
12266 # This field is used in optimistic locking. This field will be ignored when
12267 # inserting a BackendService. An up-to-date fingerprint must be provided in
12268 # order to update the BackendService, otherwise the request will
12269 # fail with error 412 conditionNotMet.
12270 #
12271 # To see the latest fingerprint, make a get() request to
12272 # retrieve a BackendService.
12273 &quot;haPolicy&quot;: { # Configures self-managed High Availability (HA) for External and Internal
12274 # Protocol Forwarding.
12275 #
12276 # The backends of this regional backend service must only specify zonal
12277 # network endpoint groups (NEGs) of type GCE_VM_IP.
12278 #
12279 # When haPolicy is set for an Internal Passthrough Network Load Balancer, the
12280 # regional backend service must set the network field. All zonal NEGs must
12281 # belong to the same network. However, individual NEGs can
12282 # belong to different subnetworks of that network.
12283 #
12284 # When haPolicy is specified, the set of attached network endpoints across
12285 # all backends comprise an High Availability domain from which one endpoint
12286 # is selected as the active endpoint (the leader) that receives all
12287 # traffic.
12288 #
12289 # haPolicy can be added only at backend service creation time. Once set up,
12290 # it cannot be deleted.
12291 #
12292 # Note that haPolicy is not for load balancing, and therefore cannot be
12293 # specified with sessionAffinity, connectionTrackingPolicy, and
12294 # failoverPolicy.
12295 #
12296 # haPolicy requires customers to be responsible for tracking backend
12297 # endpoint health and electing a leader among the healthy endpoints.
12298 # Therefore, haPolicy cannot be specified with healthChecks.
12299 #
12300 # haPolicy can only be specified for External Passthrough Network Load
12301 # Balancers and Internal Passthrough Network Load Balancers.
12302 &quot;fastIPMove&quot;: &quot;A String&quot;, # Specifies whether fast IP move is enabled, and if so, the mechanism to
12303 # achieve it.
12304 #
12305 # Supported values are:
12306 #
12307 # - DISABLED: Fast IP Move is disabled. You can only use the
12308 # haPolicy.leader API to update the leader.
12309 # - &gt;GARP_RA: Provides a method to very quickly define a new network
12310 # endpoint as the leader. This method is faster than updating the leader
12311 # using the haPolicy.leader API. Fast IP move works as follows: The VM
12312 # hosting the network endpoint that should become the new leader sends
12313 # either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router
12314 # Advertisement(RA) packet (IPv6). Google Cloud immediately but
12315 # temporarily associates the forwarding rule IP address with that VM, and
12316 # both new and in-flight packets are quickly delivered to that VM.
12317 #
12318 #
12319 #
12320 # Note the important properties of the Fast IP Move functionality:
12321 #
12322 # - The GARP/RA-initiated re-routing stays active for approximately 20
12323 # minutes. After triggering fast failover, you must also
12324 # appropriately set the haPolicy.leader.
12325 # - The new leader instance should continue to send GARP/RA packets
12326 # periodically every 10 seconds until at least 10 minutes after updating
12327 # the haPolicy.leader (but stop immediately if it is no longer the leader).
12328 # - After triggering a fast failover, we recommend that you wait at least
12329 # 3 seconds before sending another GARP/RA packet from a different VM
12330 # instance to avoid race conditions.
12331 # - Don&#x27;t send GARP/RA packets from different VM
12332 # instances at the same time. If multiple instances continue to send
12333 # GARP/RA packets, traffic might be routed to different destinations in an
12334 # alternating order. This condition ceases when a single instance
12335 # issues a GARP/RA packet.
12336 # - The GARP/RA request always takes priority over the leader API.
12337 # Using the haPolicy.leader API to change the leader to a different
12338 # instance will have no effect until the GARP/RA request becomes
12339 # inactive.
12340 # - The GARP/RA packets should follow the GARP/RA
12341 # Packet Specifications..
12342 # - When multiple forwarding rules refer to a regional backend service,
12343 # you need only send a GARP or RA packet for a single forwarding rule
12344 # virtual IP. The virtual IPs for all forwarding rules targeting the same
12345 # backend service will also be moved to the sender of the GARP or RA
12346 # packet.
12347 #
12348 #
12349 #
12350 # The following are the Fast IP Move limitations (that is, when fastIPMove
12351 # is not DISABLED):
12352 #
12353 # - Multiple forwarding rules cannot use the same IP address if one of
12354 # them refers to a regional backend service with fastIPMove.
12355 # - The regional backend service must set the network field, and all
12356 # NEGs must belong to that network. However, individual
12357 # NEGs can belong to different subnetworks of that network.
12358 # - The maximum number of network endpoints across all backends of a
12359 # backend service with fastIPMove is 32.
12360 # - The maximum number of backend services with fastIPMove that can have
12361 # the same network endpoint attached to one of its backends is 64.
12362 # - The maximum number of backend services with fastIPMove in a VPC in a
12363 # region is 64.
12364 # - The network endpoints that are attached to a backend of a backend
12365 # service with fastIPMove cannot resolve to Gen3+ machines for IPv6.
12366 # - Traffic directed to the leader by a static route next hop will not be
12367 # redirected to a new leader by fast failover. Such traffic will only be
12368 # redirected once an haPolicy.leader update has taken effect. Only traffic
12369 # to the forwarding rule&#x27;s virtual IP will be redirected to a new leader by
12370 # fast failover.
12371 #
12372 #
12373 # haPolicy.fastIPMove can be set only at backend service creation time.
12374 # Once set, it cannot be updated.
12375 #
12376 # By default, fastIpMove is set to DISABLED.
12377 &quot;leader&quot;: { # Selects one of the network endpoints attached to the backend NEGs of
12378 # this service as the active endpoint (the leader) that receives all
12379 # traffic.
12380 #
12381 # When the leader changes, there is no connection draining to persist
12382 # existing connections on the old leader.
12383 #
12384 # You are responsible for selecting a suitable endpoint as the
12385 # leader. For example, preferring a healthy endpoint over unhealthy ones.
12386 # Note that this service does not track backend endpoint health, and
12387 # selects the configured leader unconditionally.
12388 &quot;backendGroup&quot;: &quot;A String&quot;, # A fully-qualified URL (starting with https://www.googleapis.com/)
12389 # of the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints
12390 # that the leader is attached to.
12391 #
12392 # The leader&#x27;s backendGroup must already be specified as a backend of
12393 # this backend service. Removing a backend that is designated as the
12394 # leader&#x27;s backendGroup is not permitted.
12395 &quot;networkEndpoint&quot;: { # The network endpoint within the leader.backendGroup that is
12396 # designated as the leader.
12397 #
12398 # This network endpoint cannot be detached from the NEG specified in
12399 # the haPolicy.leader.backendGroup until the leader is updated with
12400 # another network endpoint, or the leader is removed from the haPolicy.
12401 &quot;instance&quot;: &quot;A String&quot;, # The name of the VM instance of the leader network endpoint. The
12402 # instance must already be attached to the NEG specified in the
12403 # haPolicy.leader.backendGroup.
12404 #
12405 # The name must be 1-63 characters long, and comply with RFC1035.
12406 # Authorization requires the following IAM permission on the
12407 # specified resource instance: compute.instances.use
12408 },
12409 },
12410 },
12411 &quot;healthChecks&quot;: [ # The list of URLs to the healthChecks, httpHealthChecks (legacy), or
12412 # httpsHealthChecks (legacy) resource for health checking this backend
12413 # service. Not all backend services support legacy health checks. See
12414 # Load balancer guide. Currently, at most one health check can be
12415 # specified for each backend service. Backend services with
12416 # instance group or zonal NEG backends must have a health check unless
12417 # haPolicy is specified. Backend services with internet or serverless NEG
12418 # backends must not have a health check.
12419 #
12420 # healthChecks[] cannot be specified with haPolicy.
12421 &quot;A String&quot;,
12422 ],
12423 &quot;iap&quot;: { # Identity-Aware Proxy # The configurations for Identity-Aware Proxy on this resource.
12424 # Not available for internal passthrough Network Load Balancers and external
12425 # passthrough Network Load Balancers.
12426 &quot;enabled&quot;: True or False, # Whether the serving infrastructure will authenticate and authorize all
12427 # incoming requests.
12428 &quot;oauth2ClientId&quot;: &quot;A String&quot;, # OAuth2 client ID to use for the authentication flow.
12429 &quot;oauth2ClientSecret&quot;: &quot;A String&quot;, # OAuth2 client secret to use for the authentication flow.
12430 # For security reasons, this value cannot be retrieved via the API.
12431 # Instead, the SHA-256 hash of the value is returned in the
12432 # oauth2ClientSecretSha256 field.
12433 #
12434 # @InputOnly
12435 &quot;oauth2ClientSecretSha256&quot;: &quot;A String&quot;, # Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.
12436 },
12437 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
12438 # defined by the server.
12439 &quot;ipAddressSelectionPolicy&quot;: &quot;A String&quot;, # Specifies a preference for traffic sent from the proxy to the backend (or
12440 # from the client to the backend for proxyless gRPC).
12441 # The possible values are:
12442 #
12443 # - IPV4_ONLY: Only send IPv4 traffic to the backends of the
12444 # backend service (Instance Group, Managed Instance Group, Network Endpoint
12445 # Group), regardless of traffic from the client to the proxy. Only IPv4
12446 # health checks are used to check the health of the backends. This is the
12447 # default setting.
12448 # - PREFER_IPV6: Prioritize the connection to the endpoint&#x27;s
12449 # IPv6 address over its IPv4 address (provided there is a healthy IPv6
12450 # address).
12451 # - IPV6_ONLY: Only send IPv6 traffic to the backends of the
12452 # backend service (Instance Group, Managed Instance Group, Network Endpoint
12453 # Group), regardless of traffic from the client to the proxy. Only IPv6
12454 # health checks are used to check the health of the backends.
12455 #
12456 #
12457 #
12458 # This field is applicable to either:
12459 #
12460 # - Advanced global external Application Load Balancer (load balancing
12461 # scheme EXTERNAL_MANAGED),
12462 # - Regional external Application Load
12463 # Balancer,
12464 # - Internal proxy Network Load Balancer (load balancing
12465 # scheme INTERNAL_MANAGED),
12466 # - Regional internal Application Load
12467 # Balancer (load balancing scheme INTERNAL_MANAGED),
12468 # - Traffic
12469 # Director with Envoy proxies and proxyless gRPC (load balancing scheme
12470 # INTERNAL_SELF_MANAGED).
12471 &quot;kind&quot;: &quot;compute#backendService&quot;, # Output only. [Output Only] Type of resource. Always compute#backendService
12472 # for backend services.
12473 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the load balancer type. A backend service
12474 # created for one type of load balancer cannot be used with another.
12475 # For more information, refer toChoosing
12476 # a load balancer.
12477 &quot;localityLbPolicies&quot;: [ # A list of locality load-balancing policies to be used in order of
12478 # preference. When you use localityLbPolicies, you must set at least one
12479 # value for either the localityLbPolicies[].policy or the
12480 # localityLbPolicies[].customPolicy field. localityLbPolicies overrides any
12481 # value set in the localityLbPolicy field.
12482 #
12483 # For an example of how to use this field, seeDefine
12484 # a list of preferred policies.
12485 #
12486 # Caution: This field and its children are intended for use in a service mesh
12487 # that includes gRPC clients only. Envoy proxies can&#x27;t use backend services
12488 # that have this configuration.
12489 { # Container for either a built-in LB policy supported by gRPC or Envoy or
12490 # a custom one implemented by the end user.
12491 &quot;customPolicy&quot;: { # The configuration for a custom policy implemented by the user and
12492 # deployed with the client.
12493 &quot;data&quot;: &quot;A String&quot;, # An optional, arbitrary JSON object with configuration data, understood
12494 # by a locally installed custom policy implementation.
12495 &quot;name&quot;: &quot;A String&quot;, # Identifies the custom policy.
12496 #
12497 # The value should match the name of a custom implementation registered
12498 # on the gRPC clients. It should follow protocol buffer message naming
12499 # conventions and include the full path (for example,
12500 # myorg.CustomLbPolicy). The maximum length is 256 characters.
12501 #
12502 # Do not specify the same custom policy more than once for a
12503 # backend. If you do, the configuration is rejected.
12504 #
12505 # For an example of how to use this field, seeUse
12506 # a custom policy.
12507 },
12508 &quot;policy&quot;: { # The configuration for a built-in load balancing policy.
12509 &quot;name&quot;: &quot;A String&quot;, # The name of a locality load-balancing policy. Valid values include
12510 # ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information
12511 # about these values, see the description of localityLbPolicy.
12512 #
12513 # Do not specify the same policy more than once for a
12514 # backend. If you do, the configuration is rejected.
12515 },
12516 },
12517 ],
12518 &quot;localityLbPolicy&quot;: &quot;A String&quot;, # The load balancing algorithm used within the scope of the locality. The
12519 # possible values are:
12520 #
12521 # - ROUND_ROBIN: This is a simple policy in which each healthy
12522 # backend is selected in round robin order. This is the default.
12523 # - LEAST_REQUEST: An O(1) algorithm which
12524 # selects two random healthy hosts and picks the host which has fewer active
12525 # requests.
12526 # - RING_HASH: The ring/modulo hash load balancer implements
12527 # consistent hashing to backends. The algorithm has the property that the
12528 # addition/removal of a host from a set of N hosts only affects 1/N of the
12529 # requests.
12530 # - RANDOM: The load balancer selects a random healthy
12531 # host.
12532 # - ORIGINAL_DESTINATION: Backend host is selected
12533 # based on the client connection metadata, i.e., connections are opened to
12534 # the same address as the destination address of the incoming connection
12535 # before the connection was redirected to the load balancer.
12536 # - MAGLEV: used as a drop in replacement for the ring hash
12537 # load balancer. Maglev is not as stable as ring hash but has faster table
12538 # lookup build times and host selection times. For more information about
12539 # Maglev, see Maglev:
12540 # A Fast and Reliable Software Network Load Balancer.
12541 # - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin
12542 # Load Balancing using weights computed from Backend reported Custom Metrics.
12543 # If set, the Backend Service responses are expected to contain non-standard
12544 # HTTP response header field Endpoint-Load-Metrics. The reported
12545 # metrics to use for computing the weights are specified via thecustomMetrics field.
12546 #
12547 # This field is applicable to either:
12548 # - A regional backend service with the service protocol set to HTTP,
12549 # HTTPS, HTTP2 or H2C, and load_balancing_scheme set to
12550 # INTERNAL_MANAGED.
12551 # - A global backend service with the
12552 # load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or
12553 # EXTERNAL_MANAGED.
12554 #
12555 #
12556 # If sessionAffinity is not configured—that is, if session
12557 # affinity remains at the default value of NONE—then the
12558 # default value for localityLbPolicy
12559 # is ROUND_ROBIN. If session affinity is set to a value other
12560 # than NONE,
12561 # then the default value for localityLbPolicy isMAGLEV.
12562 #
12563 # Only ROUND_ROBIN and RING_HASH are supported
12564 # when the backend service is referenced by a URL map that is bound to
12565 # target gRPC proxy that has validateForProxyless field set to true.
12566 #
12567 # localityLbPolicy cannot be specified with haPolicy.
12568 &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
12569 # by this backend service. If logging is enabled, logs will be exported to
12570 # Stackdriver.
12571 # backend service.
12572 &quot;enable&quot;: True or False, # Denotes whether to enable logging for the load balancer
12573 # traffic served by this backend service. The default value is false.
12574 &quot;loggingHttpRequestHeaders&quot;: [ # The list of request headers that will be logged to Stackdriver.
12575 { # Determines which HTTP headers will be logged to Stackdriver.
12576 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
12577 },
12578 ],
12579 &quot;loggingHttpResponseHeaders&quot;: [ # The list of response headers that will be logged to Stackdriver.
12580 { # Determines which HTTP headers will be logged to Stackdriver.
12581 &quot;headerName&quot;: &quot;A String&quot;, # The name of the header to be logged.
12582 },
12583 ],
12584 &quot;optionalFields&quot;: [ # This field can only be specified if logging is enabled for this backend
12585 # service and &quot;logConfig.optionalMode&quot; was set to CUSTOM. Contains a list
12586 # of optional fields you want to include in the logs. For example:
12587 # serverInstance, serverGkeDetails.cluster,
12588 # serverGkeDetails.pod.podNamespace
12589 &quot;A String&quot;,
12590 ],
12591 &quot;optionalMode&quot;: &quot;A String&quot;, # This field can only be specified if logging is enabled for this backend
12592 # service. Configures whether all, none or a subset of optional fields
12593 # should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,
12594 # EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
12595 &quot;sampleRate&quot;: 3.14, # This field can only be specified if logging is enabled for this backend
12596 # service. The value of the field must be in [0, 1]. This configures the
12597 # sampling rate of requests to the load balancer where 1.0 means all logged
12598 # requests are reported and 0.0 means no logged requests are reported. The
12599 # default value is 1.0.
12600 },
12601 &quot;maxStreamDuration&quot;: { # A Duration represents a fixed-length span of time represented # Specifies the default maximum duration (timeout) for streams to this
12602 # service. Duration is computed from the beginning of the stream until the
12603 # response has been completely processed, including all retries. A stream
12604 # that does not complete in this duration is closed.
12605 #
12606 # If not specified, there will be no timeout limit, i.e. the maximum
12607 # duration is infinite.
12608 #
12609 # This value can be overridden in the PathMatcher configuration of the
12610 # UrlMap that references this backend service.
12611 #
12612 # This field is only allowed when the loadBalancingScheme of
12613 # the backend service is INTERNAL_SELF_MANAGED.
12614 # as a count of seconds and fractions of seconds at nanosecond
12615 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
12616 # or &quot;month&quot;. Range is approximately 10,000 years.
12617 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
12618 # Durations less than one second are represented with a 0
12619 # `seconds` field and a positive `nanos` field. Must be from 0
12620 # to 999,999,999 inclusive.
12621 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
12622 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
12623 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
12624 },
12625 &quot;metadatas&quot;: { # Deployment metadata associated with the resource to be set by a GKE hub
12626 # controller and read by the backend RCTH
12627 &quot;a_key&quot;: &quot;A String&quot;,
12628 },
12629 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
12630 # The name must be 1-63 characters long, and comply withRFC1035.
12631 # Specifically, the name must be 1-63 characters long and match the regular
12632 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
12633 # character must be a lowercase letter, and all following characters must
12634 # be a dash, lowercase letter, or digit, except the last character, which
12635 # cannot be a dash.
12636 &quot;network&quot;: &quot;A String&quot;, # The URL of the network to which this backend service belongs.
12637 #
12638 # This field must be set for Internal Passthrough Network Load Balancers when
12639 # the haPolicy is enabled, and for External Passthrough Network Load
12640 # Balancers when the haPolicy fastIpMove is enabled.
12641 #
12642 # 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.
12643 &quot;networkPassThroughLbTrafficPolicy&quot;: { # Configures traffic steering properties of internal passthrough Network
12644 # Load Balancers.
12645 #
12646 # networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
12647 &quot;zonalAffinity&quot;: { # When configured, new connections are load balanced across healthy backend
12648 # endpoints in the local zone.
12649 &quot;spillover&quot;: &quot;A String&quot;, # This field indicates whether zonal affinity is enabled or not. The
12650 # possible values are:
12651 #
12652 # - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity
12653 # is disabled. The load balancer distributes new connections to all
12654 # healthy backend endpoints across all zones.
12655 # - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is
12656 # enabled. The load balancer distributes new connections to all healthy
12657 # backend endpoints in the local zone only. If there are no healthy
12658 # backend endpoints in the local zone, the load balancer distributes
12659 # new connections to all backend endpoints in the local zone.
12660 # - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is
12661 # enabled. The load balancer distributes new connections to all healthy
12662 # backend endpoints in the local zone only. If there aren&#x27;t enough
12663 # healthy backend endpoints in the local zone, the load balancer
12664 # distributes new connections to all healthy backend endpoints across all
12665 # zones.
12666 &quot;spilloverRatio&quot;: 3.14, # The value of the field must be in [0, 1]. When the ratio of the count
12667 # of healthy backend endpoints in a zone to the count of backend
12668 # endpoints in that same zone is equal to or above this threshold, the
12669 # load balancer distributes new connections to all healthy endpoints in
12670 # the local zone only. When the ratio of the count of healthy backend
12671 # endpoints in a zone to the count of backend endpoints in that same
12672 # zone is below this threshold, the load balancer distributes all new
12673 # connections to all healthy endpoints across all zones.
12674 },
12675 },
12676 &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.
12677 # the backend service.
12678 &quot;resourceUri&quot;: &quot;A String&quot;, # The resource URI of the resource or system that manages the backend
12679 # service.
12680 },
12681 &quot;outlierDetection&quot;: { # Settings controlling the eviction of unhealthy hosts from the load balancing # Settings controlling the ejection of unhealthy backend endpoints from the
12682 # load balancing pool of each individual proxy instance that processes the
12683 # traffic for the given backend service. If not set, this feature is
12684 # considered disabled.
12685 #
12686 # Results of the outlier detection algorithm (ejection of endpoints from the
12687 # load balancing pool and returning them back to the pool) are executed
12688 # independently by each proxy instance of the load balancer. In most cases,
12689 # more than one proxy instance handles the traffic received by a backend
12690 # service. Thus, it is possible that an unhealthy endpoint is detected and
12691 # ejected by only some of the proxies, and while this happens, other proxies
12692 # may continue to send requests to the same unhealthy endpoint until they
12693 # detect and eject the unhealthy endpoint.
12694 #
12695 # Applicable backend endpoints can be:
12696 #
12697 # - VM instances in an Instance Group
12698 # - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)
12699 # - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)
12700 # - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud
12701 # Functions Services
12702 # - Private Service Connect NEGs, that resolve to
12703 # Google-managed regional API endpoints or managed services published using
12704 # Private Service Connect
12705 #
12706 #
12707 #
12708 # Applicable backend service types can be:
12709 #
12710 # - A global backend service with the loadBalancingScheme set to
12711 # INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED.
12712 # - A regional backend
12713 # service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and
12714 # loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not
12715 # supported for Serverless NEGs.
12716 #
12717 #
12718 #
12719 # Not supported when the backend service is referenced by a URL map that is
12720 # bound to target gRPC proxy that has validateForProxyless field set to true.
12721 # pool for the backend service.
12722 &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
12723 # or 30s.
12724 #
12725 # After a backend endpoint is returned back to the load balancing pool, it
12726 # can be ejected again in another ejection analysis. Thus, the total ejection
12727 # time is equal to the base ejection time multiplied by the number of times
12728 # the backend endpoint has been ejected. Defaults to 30000ms or 30s.
12729 # as a count of seconds and fractions of seconds at nanosecond
12730 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
12731 # or &quot;month&quot;. Range is approximately 10,000 years.
12732 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
12733 # Durations less than one second are represented with a 0
12734 # `seconds` field and a positive `nanos` field. Must be from 0
12735 # to 999,999,999 inclusive.
12736 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
12737 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
12738 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
12739 },
12740 &quot;consecutiveErrors&quot;: 42, # Number of consecutive errors before a backend endpoint is ejected from the
12741 # load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx
12742 # return code qualifies as an error. Defaults to 5.
12743 &quot;consecutiveGatewayFailure&quot;: 42, # The number of consecutive gateway failures (502, 503, 504 status or
12744 # connection errors that are mapped to one of those status codes) before a
12745 # consecutive gateway failure ejection occurs. Defaults to 3.
12746 &quot;enforcingConsecutiveErrors&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
12747 # outlier status is detected through consecutive 5xx. This setting can be
12748 # used to disable ejection or to ramp it up slowly. Defaults to 0.
12749 &quot;enforcingConsecutiveGatewayFailure&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
12750 # outlier status is detected through consecutive gateway failures. This
12751 # setting can be used to disable ejection or to ramp it up slowly. Defaults
12752 # to 100.
12753 &quot;enforcingSuccessRate&quot;: 42, # The percentage chance that a backend endpoint will be ejected when an
12754 # outlier status is detected through success rate statistics. This setting
12755 # can be used to disable ejection or to ramp it up slowly. Defaults to 100.
12756 #
12757 # Not supported when the backend service uses Serverless NEG.
12758 &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
12759 # ejections and backend endpoints being returned to service. The interval is
12760 # equal to the number of seconds as defined in
12761 # outlierDetection.interval.seconds plus the number of nanoseconds as defined
12762 # in outlierDetection.interval.nanos. Defaults to 1 second.
12763 # as a count of seconds and fractions of seconds at nanosecond
12764 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
12765 # or &quot;month&quot;. Range is approximately 10,000 years.
12766 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
12767 # Durations less than one second are represented with a 0
12768 # `seconds` field and a positive `nanos` field. Must be from 0
12769 # to 999,999,999 inclusive.
12770 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
12771 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
12772 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
12773 },
12774 &quot;maxEjectionPercent&quot;: 42, # Maximum percentage of backend endpoints in the load balancing pool for the
12775 # backend service that can be ejected if the ejection conditions are met.
12776 # Defaults to 50%.
12777 &quot;successRateMinimumHosts&quot;: 42, # The number of backend endpoints in the load balancing pool that must have
12778 # enough request volume to detect success rate outliers. If the number of
12779 # backend endpoints is fewer than this setting, outlier detection via success
12780 # rate statistics is not performed for any backend endpoint in the load
12781 # balancing pool. Defaults to 5.
12782 #
12783 # Not supported when the backend service uses Serverless NEG.
12784 &quot;successRateRequestVolume&quot;: 42, # The minimum number of total requests that must be collected in one interval
12785 # (as defined by the interval duration above) to include this backend
12786 # endpoint in success rate based outlier detection. If the volume is lower
12787 # than this setting, outlier detection via success rate statistics is not
12788 # performed for that backend endpoint. Defaults to 100.
12789 #
12790 # Not supported when the backend service uses Serverless NEG.
12791 &quot;successRateStdevFactor&quot;: 42, # This factor is used to determine the ejection threshold for success rate
12792 # outlier ejection. The ejection threshold is the difference between the mean
12793 # success rate, and the product of this factor and the standard deviation of
12794 # the mean success rate: mean - (stdev * successRateStdevFactor). This factor
12795 # is divided by a thousand to get a double. That is, if the desired factor
12796 # is 1.9, the runtime value should be 1900. Defaults to 1900.
12797 #
12798 # Not supported when the backend service uses Serverless NEG.
12799 },
12800 &quot;params&quot;: { # Additional Backend Service parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
12801 # as part of resource payload.
12802 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
12803 # Tag keys and values have the same definition as resource
12804 # manager tags. The field is allowed for INSERT
12805 # only. The keys/values to set on the resource should be specified in
12806 # either ID { : } or Namespaced format
12807 # { : }.
12808 # For example the following are valid inputs:
12809 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
12810 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
12811 # Note:
12812 # * Invalid combinations of ID &amp; namespaced format is not supported. For
12813 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
12814 &quot;a_key&quot;: &quot;A String&quot;,
12815 },
12816 },
12817 &quot;port&quot;: 42, # Deprecated in favor of portName. The TCP port to connect on
12818 # the backend. The default value is 80.
12819 # For internal passthrough Network Load Balancers and external passthrough
12820 # Network Load Balancers, omit port.
12821 &quot;portName&quot;: &quot;A String&quot;, # A named port on a backend instance group representing the port for
12822 # communication to the backend VMs in that group. The
12823 # named port must be [defined on each backend instance
12824 # group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).
12825 # This parameter has no meaning if the backends are NEGs. For internal
12826 # passthrough Network Load Balancers and external passthrough Network Load
12827 # Balancers, omit port_name.
12828 &quot;protocol&quot;: &quot;A String&quot;, # The protocol this BackendService uses to communicate
12829 # with backends.
12830 #
12831 # Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
12832 # depending on the chosen load balancer or Traffic Director configuration.
12833 # Refer to the documentation for the load balancers or for Traffic Director
12834 # for more information.
12835 #
12836 # Must be set to GRPC when the backend service is referenced by a URL map
12837 # that is bound to target gRPC proxy.
12838 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend service
12839 # resides. This field is not applicable to global backend services.
12840 # You must specify this field as part of the HTTP request URL. It is
12841 # not settable as a field in the request body.
12842 &quot;securityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the security policy associated with this
12843 # backend service.
12844 &quot;securitySettings&quot;: { # The authentication and authorization settings for a BackendService. # This field specifies the security settings that apply to this backend
12845 # service. This field is applicable to a global backend service with the
12846 # load_balancing_scheme set to INTERNAL_SELF_MANAGED.
12847 &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
12848 # storage buckets that support AWS&#x27;s Signature Version 4 for authentication.
12849 # Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.
12850 # private storage buckets that support Signature Version 4 for authentication.
12851 # The service name for generating the authentication header will always default
12852 # to &#x27;s3&#x27;.
12853 &quot;accessKey&quot;: &quot;A String&quot;, # The access key used for s3 bucket authentication. Required for updating or
12854 # creating a backend that uses AWS v4 signature authentication, but will not
12855 # be returned as part of the configuration when queried with a REST API GET
12856 # request.
12857 #
12858 # @InputOnly
12859 &quot;accessKeyId&quot;: &quot;A String&quot;, # The identifier of an access key used for s3 bucket authentication.
12860 &quot;accessKeyVersion&quot;: &quot;A String&quot;, # The optional version identifier for the access key. You can use this to
12861 # keep track of different iterations of your access key.
12862 &quot;originRegion&quot;: &quot;A String&quot;, # The name of the cloud region of your origin. This is a free-form field with
12863 # the name of the region your cloud uses to host your origin. For example,
12864 # &quot;us-east-1&quot; for AWS or &quot;us-ashburn-1&quot; for OCI.
12865 },
12866 &quot;clientTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ClientTlsPolicy resource
12867 # that describes how clients should authenticate with this service&#x27;s
12868 # backends.
12869 #
12870 # clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set
12871 # to INTERNAL_SELF_MANAGED.
12872 #
12873 # If left blank, communications are not encrypted.
12874 &quot;subjectAltNames&quot;: [ # Optional. A list of Subject Alternative Names (SANs) that the client
12875 # verifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate
12876 # to the client, the client inspects the certificate&#x27;ssubjectAltName field. If the field contains one of the
12877 # specified values, the communication continues. Otherwise, it fails. This
12878 # additional check enables the client to verify that the server is authorized
12879 # to run the requested service.
12880 #
12881 # Note that the contents of the server
12882 # certificate&#x27;s subjectAltName field are configured by the
12883 # Public Key Infrastructure which provisions server identities.
12884 #
12885 # Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.
12886 # Only applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS
12887 # mode).
12888 &quot;A String&quot;,
12889 ],
12890 },
12891 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
12892 &quot;serviceBindings&quot;: [ # URLs of networkservices.ServiceBinding resources.
12893 #
12894 # Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED.
12895 # If set, lists of backends and health checks must be both empty.
12896 &quot;A String&quot;,
12897 ],
12898 &quot;serviceLbPolicy&quot;: &quot;A String&quot;, # URL to networkservices.ServiceLbPolicy resource.
12899 #
12900 # Can only be set if load balancing scheme is EXTERNAL_MANAGED,
12901 # INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
12902 &quot;sessionAffinity&quot;: &quot;A String&quot;, # Type of session affinity to use. The default is NONE.
12903 #
12904 # Only NONE and HEADER_FIELD are supported
12905 # when the backend service is referenced by a URL map that is bound to
12906 # target gRPC proxy that has validateForProxyless field set to true.
12907 #
12908 # For more details, see:
12909 # [Session
12910 # Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).
12911 #
12912 # sessionAffinity cannot be specified with haPolicy.
12913 &quot;strongSessionAffinityCookie&quot;: { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is
12914 # applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
12915 &quot;name&quot;: &quot;A String&quot;, # Name of the cookie.
12916 &quot;path&quot;: &quot;A String&quot;, # Path to set for the cookie.
12917 &quot;ttl&quot;: { # A Duration represents a fixed-length span of time represented # Lifetime of the cookie.
12918 # as a count of seconds and fractions of seconds at nanosecond
12919 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
12920 # or &quot;month&quot;. Range is approximately 10,000 years.
12921 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
12922 # Durations less than one second are represented with a 0
12923 # `seconds` field and a positive `nanos` field. Must be from 0
12924 # to 999,999,999 inclusive.
12925 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
12926 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
12927 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
12928 },
12929 },
12930 &quot;subsetting&quot;: { # Subsetting configuration for this BackendService. # subsetting cannot be specified with haPolicy.
12931 # Currently this is applicable only for Internal TCP/UDP load balancing,
12932 # Internal HTTP(S) load balancing and Traffic Director.
12933 &quot;policy&quot;: &quot;A String&quot;,
12934 },
12935 &quot;timeoutSec&quot;: 42, # The backend service timeout has a different meaning depending on the
12936 # type of load balancer. For more information see,
12937 # Backend service settings.
12938 # The default is 30 seconds.
12939 # The full range of timeout values allowed goes from 1
12940 # through 2,147,483,647 seconds.
12941 #
12942 # This value can be overridden in the PathMatcher configuration of the
12943 # UrlMap that references this backend service.
12944 #
12945 # Not supported when the backend service is referenced by a URL map that is
12946 # bound to target gRPC proxy that has validateForProxyless field set to true.
12947 # Instead, use maxStreamDuration.
12948 &quot;tlsSettings&quot;: { # Configuration for Backend Authenticated TLS and mTLS. May only be specified
12949 # when the backend protocol is SSL, HTTPS or HTTP2.
12950 &quot;authenticationConfig&quot;: &quot;A String&quot;, # Reference to the BackendAuthenticationConfig resource from the
12951 # networksecurity.googleapis.com namespace. Can be used in authenticating
12952 # TLS connections to the backend, as specified by the authenticationMode
12953 # field. Can only be specified if authenticationMode is not NONE.
12954 &quot;sni&quot;: &quot;A String&quot;, # Server Name Indication - see RFC3546 section 3.1. If set, the load
12955 # balancer sends this string as the SNI hostname in the TLS connection to
12956 # the backend, and requires that this string match a Subject Alternative
12957 # Name (SAN) in the backend&#x27;s server certificate. With a Regional Internet
12958 # NEG backend, if the SNI is specified here, the load balancer uses it
12959 # regardless of whether the Regional Internet NEG is specified with FQDN or
12960 # IP address and port. When both sni and subjectAltNames[] are specified,
12961 # the load balancer matches the backend certificate&#x27;s SAN only to
12962 # subjectAltNames[].
12963 &quot;subjectAltNames&quot;: [ # A list of Subject Alternative Names (SANs) that the Load Balancer
12964 # verifies during a TLS handshake with the backend. When the server
12965 # presents its X.509 certificate to the Load Balancer, the Load Balancer
12966 # inspects the certificate&#x27;s SAN field, and requires that at least one SAN
12967 # match one of the subjectAltNames in the list. This field is limited to 5
12968 # entries. When both sni and subjectAltNames[] are specified, the load
12969 # balancer matches the backend certificate&#x27;s SAN only to subjectAltNames[].
12970 { # A Subject Alternative Name that the load balancer matches against the SAN
12971 # field in the TLS certificate provided by the backend, specified as either
12972 # a DNS name or a URI, in accordance with RFC 5280 4.2.1.6
12973 &quot;dnsName&quot;: &quot;A String&quot;, # The SAN specified as a DNS Name.
12974 &quot;uniformResourceIdentifier&quot;: &quot;A String&quot;, # The SAN specified as a URI.
12975 },
12976 ],
12977 },
12978 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing given backend service.
12979 {
12980 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for resources referencing given
12981 # BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies
12982 # and ForwardingRule.
12983 },
12984 ],
12985 }
12986
12987 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
12988 that if you must retry your request, the server will know to ignore the
12989 request if it has already been completed.
12990
12991 For example, consider a situation where you make an initial request and
12992 the request times out. If you make the request again with the same
12993 request ID, the server can check if original operation with the same
12994 request ID was received, and if so, will ignore the second request. This
12995 prevents clients from accidentally creating duplicate commitments.
12996
12997 The request ID must be
12998 a valid UUID with the exception that zero UUID is not supported
12999 (00000000-0000-0000-0000-000000000000).
13000 x__xgafv: string, V1 error format.
13001 Allowed values
13002 1 - v1 error format
13003 2 - v2 error format
13004
13005 Returns:
13006 An object of the form:
13007
13008 { # Represents an Operation resource.
13009 #
13010 # Google Compute Engine has three Operation resources:
13011 #
13012 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
13013 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
13014 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
13015 #
13016 # You can use an operation resource to manage asynchronous API requests.
13017 # For more information, readHandling
13018 # API responses.
13019 #
13020 # Operations can be global, regional or zonal.
13021 #
13022 # - For global operations, use the `globalOperations`
13023 # resource.
13024 # - For regional operations, use the
13025 # `regionOperations` resource.
13026 # - For zonal operations, use
13027 # the `zoneOperations` resource.
13028 #
13029 #
13030 #
13031 # For more information, read
13032 # Global, Regional, and Zonal Resources.
13033 #
13034 # Note that completed Operation resources have a limited
13035 # retention period.
13036 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
13037 # Not present otherwise.
13038 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
13039 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
13040 # set when the operation is created.
13041 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
13042 # text format.
13043 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
13044 # this field will be populated.
13045 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
13046 # operation.
13047 {
13048 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
13049 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
13050 # details. There is a set of defined message types to use for providing
13051 # details.The syntax depends on the error code. For example,
13052 # QuotaExceededInfo will have details when the error code is
13053 # QUOTA_EXCEEDED.
13054 {
13055 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
13056 #
13057 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
13058 # is not enabled:
13059 #
13060 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
13061 # &quot;domain&quot;: &quot;googleapis.com&quot;
13062 # &quot;metadata&quot;: {
13063 # &quot;resource&quot;: &quot;projects/123&quot;,
13064 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
13065 # }
13066 # }
13067 #
13068 # This response indicates that the pubsub.googleapis.com API is not enabled.
13069 #
13070 # Example of an error that is returned when attempting to create a Spanner
13071 # instance in a region that is out of stock:
13072 #
13073 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
13074 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
13075 # &quot;metadata&quot;: {
13076 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
13077 # }
13078 # }
13079 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
13080 # is typically the registered service name of the tool or product that
13081 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
13082 # generated by some common infrastructure, the error domain must be a
13083 # globally unique value that identifies the infrastructure. For Google API
13084 # infrastructure, the error domain is &quot;googleapis.com&quot;.
13085 &quot;metadatas&quot;: { # Additional structured details about this error.
13086 #
13087 # Keys must match a regular expression of `a-z+` but should
13088 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
13089 # length. When identifying the current value of an exceeded limit, the units
13090 # should be contained in the key, not the value. For example, rather than
13091 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
13092 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
13093 # instances that can be created in a single (batch) request.
13094 &quot;a_key&quot;: &quot;A String&quot;,
13095 },
13096 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
13097 # proximate cause of the error. Error reasons are unique within a particular
13098 # domain of errors. This should be at most 63 characters and match a
13099 # regular expression of `A-Z+[A-Z0-9]`, which represents
13100 # UPPER_SNAKE_CASE.
13101 },
13102 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
13103 #
13104 # For example, if a quota check failed with an error indicating the calling
13105 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
13106 # directly to the right place in the developer console to flip the bit.
13107 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
13108 { # Describes a URL link.
13109 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
13110 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
13111 },
13112 ],
13113 },
13114 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
13115 # which can be attached to an RPC error.
13116 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
13117 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
13118 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
13119 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
13120 },
13121 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
13122 &quot;dimensions&quot;: { # The map holding related quota dimensions.
13123 &quot;a_key&quot;: &quot;A String&quot;,
13124 },
13125 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
13126 # type or metric.
13127 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
13128 # or metric.
13129 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
13130 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
13131 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
13132 },
13133 },
13134 ],
13135 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
13136 # This property is optional.
13137 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
13138 },
13139 ],
13140 },
13141 &quot;getVersionOperationMetadata&quot;: {
13142 &quot;inlineSbomInfo&quot;: {
13143 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
13144 # appropriate identifiers.
13145 &quot;a_key&quot;: &quot;A String&quot;,
13146 },
13147 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
13148 # identifiers.
13149 &quot;a_key&quot;: &quot;A String&quot;,
13150 },
13151 },
13152 },
13153 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
13154 # message that was returned, such as `NOT FOUND`.
13155 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
13156 # status code that was returned. For example, a `404` means the
13157 # resource was not found.
13158 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
13159 # defined by the server.
13160 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
13161 # This value is inRFC3339
13162 # text format.
13163 &quot;instancesBulkInsertOperationMetadata&quot;: {
13164 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
13165 # Example key: zones/us-central1-a
13166 &quot;a_key&quot;: {
13167 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
13168 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
13169 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
13170 # error.
13171 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
13172 # if the flow is rolling forward or rolling back.
13173 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
13174 },
13175 },
13176 },
13177 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
13178 # Operation resources.
13179 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
13180 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
13181 # group of operations results from a `bulkInsert` API request.
13182 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
13183 # `update`, or `delete`, and so on.
13184 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
13185 # There is no requirement that this be linear or support any granularity of
13186 # operations. This should not be used to guess when the operation will be
13187 # complete. This number should monotonically increase as the operation
13188 # progresses.
13189 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
13190 # applicable when performing regional operations.
13191 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
13192 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
13193 # this field will contain information on all underlying zonal actions and
13194 # their state.
13195 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
13196 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
13197 # Example key: zones/us-central1-a
13198 &quot;a_key&quot;: {
13199 &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
13200 # populated.
13201 # different programming environments, including REST APIs and RPC APIs. It is
13202 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
13203 # three pieces of data: error code, error message, and error details.
13204 #
13205 # You can find out more about this error model and how to work with it in the
13206 # [API Design Guide](https://cloud.google.com/apis/design/errors).
13207 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
13208 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
13209 # message types for APIs to use.
13210 {
13211 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
13212 },
13213 ],
13214 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
13215 # user-facing error message should be localized and sent in the
13216 # google.rpc.Status.details field, or localized by the client.
13217 },
13218 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
13219 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
13220 },
13221 },
13222 },
13223 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
13224 # This value is inRFC3339
13225 # text format.
13226 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
13227 # following:
13228 # `PENDING`, `RUNNING`, or `DONE`.
13229 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
13230 # operation.
13231 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
13232 # of the target resource.
13233 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
13234 # operations related to creating a snapshot, this points to the disk
13235 # that the snapshot was created from.
13236 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
13237 # `[email protected]` or
13238 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
13239 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
13240 # operation, this field will be populated.
13241 {
13242 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
13243 # Engine returns NO_RESULTS_ON_PAGE if there
13244 # are no results in the response.
13245 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
13246 # value format. For example:
13247 #
13248 # &quot;data&quot;: [
13249 # {
13250 # &quot;key&quot;: &quot;scope&quot;,
13251 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
13252 # }
13253 {
13254 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
13255 # returned. For example, for warnings where there are no results in a list
13256 # request for a particular zone, this key might be scope and
13257 # the key value might be the zone name. Other examples might be a key
13258 # indicating a deprecated resource and a suggested replacement, or a
13259 # warning about invalid network settings (for example, if an instance
13260 # attempts to perform IP forwarding but is not enabled for IP forwarding).
13261 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
13262 },
13263 ],
13264 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
13265 },
13266 ],
13267 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
13268 # applicable when performing per-zone operations.
13269 }</pre>
13270 </div>
13271
13272 </body></html>