Debian Codegraph @

docs/dyn/compute_beta.regionBackendBuckets.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.regionBackendBuckets.html">regionBackendBuckets</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#delete">delete(project, region, backendBucket, forceDelete=None, requestId=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Deletes the specified regional BackendBucket resource.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(project, region, backendBucket, x__xgafv=None)</a></code></p>
85 <p class="firstline">Returns the specified regional BackendBucket resource.</p>
86 <p class="toc_element">
87 <code><a href="#getIamPolicy">getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Gets the access control policy for a resource. May be empty if no such</p>
89 <p class="toc_element">
90 <code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Creates a RegionBackendBucket in the specified project in the given scope</p>
92 <p class="toc_element">
93 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Retrieves the list of BackendBucket resources available to the specified</p>
95 <p class="toc_element">
96 <code><a href="#listUsable">listUsable(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Retrieves a list of all usable backend buckets in the specified project in</p>
98 <p class="toc_element">
99 <code><a href="#listUsable_next">listUsable_next()</a></code></p>
100 <p class="firstline">Retrieves the next page of results.</p>
101 <p class="toc_element">
102 <code><a href="#list_next">list_next()</a></code></p>
103 <p class="firstline">Retrieves the next page of results.</p>
104 <p class="toc_element">
105 <code><a href="#patch">patch(project, region, backendBucket, body=None, requestId=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Updates the specified BackendBucket resource with the data included in the</p>
107 <p class="toc_element">
108 <code><a href="#setIamPolicy">setIamPolicy(project, region, resource, body=None, x__xgafv=None)</a></code></p>
109 <p class="firstline">Sets the access control policy on the specified resource.</p>
110 <p class="toc_element">
111 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</a></code></p>
112 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
113 <h3>Method Details</h3>
114 <div class="method">
115 <code class="details" id="close">close()</code>
116 <pre>Close httplib2 connections.</pre>
117 </div>
118
119 <div class="method">
120 <code class="details" id="delete">delete(project, region, backendBucket, forceDelete=None, requestId=None, x__xgafv=None)</code>
121 <pre>Deletes the specified regional BackendBucket resource.
122
123 Args:
124 project: string, Project ID for this request. (required)
125 region: string, Name of the region scoping this request. (required)
126 backendBucket: string, Name of the BackendBucket resource to delete. (required)
127 forceDelete: boolean, Force delete the backend bucket even if it is still in use by other
128 resources. It&#x27;s intended to be used internally only for requests from
129 wipeout.
130 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
131 that if you must retry your request, the server will know to ignore the
132 request if it has already been completed.
133
134 For example, consider a situation where you make an initial request and
135 the request times out. If you make the request again with the same
136 request ID, the server can check if original operation with the same
137 request ID was received, and if so, will ignore the second request. This
138 prevents clients from accidentally creating duplicate commitments.
139
140 The request ID must be
141 a valid UUID with the exception that zero UUID is not supported
142 (00000000-0000-0000-0000-000000000000).
143 end_interface: MixerMutationRequestBuilder
144 x__xgafv: string, V1 error format.
145 Allowed values
146 1 - v1 error format
147 2 - v2 error format
148
149 Returns:
150 An object of the form:
151
152 { # Represents an Operation resource.
153 #
154 # Google Compute Engine has three Operation resources:
155 #
156 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
157 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
158 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
159 #
160 # You can use an operation resource to manage asynchronous API requests.
161 # For more information, readHandling
162 # API responses.
163 #
164 # Operations can be global, regional or zonal.
165 #
166 # - For global operations, use the `globalOperations`
167 # resource.
168 # - For regional operations, use the
169 # `regionOperations` resource.
170 # - For zonal operations, use
171 # the `zoneOperations` resource.
172 #
173 #
174 #
175 # For more information, read
176 # Global, Regional, and Zonal Resources.
177 #
178 # Note that completed Operation resources have a limited
179 # retention period.
180 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
181 # Not present otherwise.
182 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
183 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
184 # set when the operation is created.
185 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
186 # text format.
187 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
188 # this field will be populated.
189 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
190 # operation.
191 {
192 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
193 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
194 # details. There is a set of defined message types to use for providing
195 # details.The syntax depends on the error code. For example,
196 # QuotaExceededInfo will have details when the error code is
197 # QUOTA_EXCEEDED.
198 {
199 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
200 #
201 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
202 # is not enabled:
203 #
204 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
205 # &quot;domain&quot;: &quot;googleapis.com&quot;
206 # &quot;metadata&quot;: {
207 # &quot;resource&quot;: &quot;projects/123&quot;,
208 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
209 # }
210 # }
211 #
212 # This response indicates that the pubsub.googleapis.com API is not enabled.
213 #
214 # Example of an error that is returned when attempting to create a Spanner
215 # instance in a region that is out of stock:
216 #
217 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
218 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
219 # &quot;metadata&quot;: {
220 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
221 # }
222 # }
223 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
224 # is typically the registered service name of the tool or product that
225 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
226 # generated by some common infrastructure, the error domain must be a
227 # globally unique value that identifies the infrastructure. For Google API
228 # infrastructure, the error domain is &quot;googleapis.com&quot;.
229 &quot;metadatas&quot;: { # Additional structured details about this error.
230 #
231 # Keys must match a regular expression of `a-z+` but should
232 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
233 # length. When identifying the current value of an exceeded limit, the units
234 # should be contained in the key, not the value. For example, rather than
235 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
236 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
237 # instances that can be created in a single (batch) request.
238 &quot;a_key&quot;: &quot;A String&quot;,
239 },
240 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
241 # proximate cause of the error. Error reasons are unique within a particular
242 # domain of errors. This should be at most 63 characters and match a
243 # regular expression of `A-Z+[A-Z0-9]`, which represents
244 # UPPER_SNAKE_CASE.
245 },
246 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
247 #
248 # For example, if a quota check failed with an error indicating the calling
249 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
250 # directly to the right place in the developer console to flip the bit.
251 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
252 { # Describes a URL link.
253 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
254 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
255 },
256 ],
257 },
258 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
259 # which can be attached to an RPC error.
260 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
261 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
262 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
263 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
264 },
265 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
266 &quot;dimensions&quot;: { # The map holding related quota dimensions.
267 &quot;a_key&quot;: &quot;A String&quot;,
268 },
269 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
270 # type or metric.
271 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
272 # or metric.
273 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
274 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
275 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
276 },
277 },
278 ],
279 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
280 # This property is optional.
281 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
282 },
283 ],
284 },
285 &quot;getVersionOperationMetadata&quot;: {
286 &quot;inlineSbomInfo&quot;: {
287 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
288 # appropriate identifiers.
289 &quot;a_key&quot;: &quot;A String&quot;,
290 },
291 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
292 # identifiers.
293 &quot;a_key&quot;: &quot;A String&quot;,
294 },
295 },
296 },
297 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
298 # message that was returned, such as `NOT FOUND`.
299 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
300 # status code that was returned. For example, a `404` means the
301 # resource was not found.
302 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
303 # defined by the server.
304 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
305 # This value is inRFC3339
306 # text format.
307 &quot;instancesBulkInsertOperationMetadata&quot;: {
308 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
309 # Example key: zones/us-central1-a
310 &quot;a_key&quot;: {
311 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
312 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
313 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
314 # error.
315 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
316 # if the flow is rolling forward or rolling back.
317 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
318 },
319 },
320 },
321 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
322 # Operation resources.
323 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
324 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
325 # group of operations results from a `bulkInsert` API request.
326 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
327 # `update`, or `delete`, and so on.
328 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
329 # There is no requirement that this be linear or support any granularity of
330 # operations. This should not be used to guess when the operation will be
331 # complete. This number should monotonically increase as the operation
332 # progresses.
333 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
334 # applicable when performing regional operations.
335 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
336 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
337 # this field will contain information on all underlying zonal actions and
338 # their state.
339 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
340 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
341 # Example key: zones/us-central1-a
342 &quot;a_key&quot;: {
343 &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
344 # populated.
345 # different programming environments, including REST APIs and RPC APIs. It is
346 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
347 # three pieces of data: error code, error message, and error details.
348 #
349 # You can find out more about this error model and how to work with it in the
350 # [API Design Guide](https://cloud.google.com/apis/design/errors).
351 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
352 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
353 # message types for APIs to use.
354 {
355 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
356 },
357 ],
358 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
359 # user-facing error message should be localized and sent in the
360 # google.rpc.Status.details field, or localized by the client.
361 },
362 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
363 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
364 },
365 },
366 },
367 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
368 # This value is inRFC3339
369 # text format.
370 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
371 # following:
372 # `PENDING`, `RUNNING`, or `DONE`.
373 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
374 # operation.
375 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
376 # of the target resource.
377 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
378 # operations related to creating a snapshot, this points to the disk
379 # that the snapshot was created from.
380 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
381 # `[email protected]` or
382 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
383 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
384 # operation, this field will be populated.
385 {
386 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
387 # Engine returns NO_RESULTS_ON_PAGE if there
388 # are no results in the response.
389 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
390 # value format. For example:
391 #
392 # &quot;data&quot;: [
393 # {
394 # &quot;key&quot;: &quot;scope&quot;,
395 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
396 # }
397 {
398 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
399 # returned. For example, for warnings where there are no results in a list
400 # request for a particular zone, this key might be scope and
401 # the key value might be the zone name. Other examples might be a key
402 # indicating a deprecated resource and a suggested replacement, or a
403 # warning about invalid network settings (for example, if an instance
404 # attempts to perform IP forwarding but is not enabled for IP forwarding).
405 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
406 },
407 ],
408 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
409 },
410 ],
411 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
412 # applicable when performing per-zone operations.
413 }</pre>
414 </div>
415
416 <div class="method">
417 <code class="details" id="get">get(project, region, backendBucket, x__xgafv=None)</code>
418 <pre>Returns the specified regional BackendBucket resource.
419
420 Args:
421 project: string, Project ID for this request. (required)
422 region: string, Name of the region scoping this request. (required)
423 backendBucket: string, Name of the BackendBucket resource to return. (required)
424 x__xgafv: string, V1 error format.
425 Allowed values
426 1 - v1 error format
427 2 - v2 error format
428
429 Returns:
430 An object of the form:
431
432 { # Represents a Cloud Storage Bucket resource.
433 #
434 # This Cloud Storage bucket resource is referenced by a URL map of a load
435 # balancer. For more information, readBackend Buckets.
436 &quot;bucketName&quot;: &quot;A String&quot;, # Cloud Storage bucket name.
437 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket.
438 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
439 # Pragma or Authorization headers. Up to 5 headers can be specified.
440 # The cache is bypassed for all cdnPolicy.cacheMode settings.
441 { # Bypass the cache when the specified request headers are present,
442 # e.g. Pragma or Authorization headers. Values are case insensitive.
443 # The presence of such a header overrides the cache_mode setting.
444 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
445 # Values are case-insensitive.
446 },
447 ],
448 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for # The CacheKeyPolicy for this CdnPolicy.
449 # Cloud CDN.
450 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
451 &quot;A String&quot;,
452 ],
453 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. Default
454 # parameters are always included. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded
455 # and not treated as delimiters.
456 &quot;A String&quot;,
457 ],
458 },
459 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
460 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
461 # headers to cache content. Responses without these headers will not be
462 # cached at Google&#x27;s edge, and will require a full trip to the origin on
463 # every request, potentially impacting performance and increasing load on
464 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
465 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
466 # Warning: this may result in Cloud CDN caching private,
467 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
468 # including common image formats, media (video and audio), and web assets
469 # (JavaScript and CSS). Requests and responses that are marked as
470 # uncacheable, as well as dynamic content (including HTML), will not be
471 # cached.
472 #
473 # If no value is provided for cdnPolicy.cacheMode, it defaults
474 # to CACHE_ALL_STATIC.
475 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
476 # used to clamp the max-age (or Expires) value sent to the client. With
477 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
478 # response max-age directive, along with a &quot;public&quot; directive. For
479 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
480 # from the origin (if specified), or else sets the response max-age
481 # directive to the lesser of the client_ttl and default_ttl, and also
482 # ensures a &quot;public&quot; cache-control directive is present.
483 # If a client TTL is not specified, a default value (1 hour) will be used.
484 # The maximum allowed value is 31,622,400s (1 year).
485 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
486 # responses that do not have an existing valid TTL (max-age or s-maxage).
487 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
488 # The value of defaultTTL cannot be set to a value greater than that of
489 # maxTTL, but can be equal.
490 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
491 # will overwrite the TTL set in all responses. The maximum allowed value is
492 # 31,622,400s (1 year), noting that infrequently accessed objects may be
493 # evicted from the cache before the defined TTL.
494 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
495 # origin.
496 # Cache directives that attempt to set a max-age or s-maxage higher than
497 # this, or an Expires header more than maxTTL seconds in the future will
498 # be capped at the value of maxTTL, as if it were the value of an
499 # s-maxage Cache-Control directive.
500 # Headers sent to the client will not be modified.
501 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
502 # The maximum allowed value is 31,622,400s (1 year), noting that
503 # infrequently accessed objects may be evicted from the cache before
504 # the defined TTL.
505 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
506 # to apply fine-grained caching for common errors or redirects.
507 # This can reduce the load on your origin and improve end-user
508 # experience by reducing response latency.
509 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
510 # negative caching applies to responses with the specified response code
511 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
512 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
513 # to all responses with the specified response code, and override any
514 # caching headers.
515 # By default, Cloud CDN will apply the following default TTLs to these
516 # status codes:
517 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
518 # HTTP 404 (Not Found), 410 (Gone),
519 # 451 (Unavailable For Legal Reasons): 120s
520 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
521 # These defaults can be overridden in negative_caching_policy.
522 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
523 # negative_caching must be enabled to configure negative_caching_policy.
524 # Omitting the policy and leaving negative_caching enabled will use
525 # Cloud CDN&#x27;s default cache TTLs.
526 # Note that when specifying an explicit negative_caching_policy, you
527 # should take care to specify a cache TTL for all response codes
528 # that you wish to cache. Cloud CDN will not apply any default
529 # negative caching when a policy exists.
530 { # Specify CDN TTLs for response error codes.
531 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
532 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
533 # specified as values, and you cannot specify a status code more than
534 # once.
535 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
536 # corresponding status code.
537 # The maximum allowed value is 1800s (30 minutes), noting that
538 # infrequently accessed objects may be evicted from the cache before the
539 # defined TTL.
540 },
541 ],
542 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
543 # requests into a small number of requests to the origin.
544 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
545 # content with the origin, or when an error is encountered when refreshing
546 # the cache.
547 # This setting defines the default &quot;max-stale&quot; duration for any cached
548 # responses that do not specify a max-stale directive. Stale responses that
549 # exceed the TTL configured here will not be served. The default limit
550 # (max-stale) is 86400s (1 day), which will allow stale content to be
551 # served up to this limit beyond the max-age (or s-maxage) of a cached
552 # response.
553 # The maximum allowed value is 604800 (1 week).
554 # Set this to zero (0) to disable serve-while-stale.
555 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
556 # considered fresh. After this time period, the response will be
557 # revalidated before being served. Defaults to 1hr (3600s). When serving
558 # responses to signed URL requests, Cloud CDN will internally behave as
559 # though all responses from this backend had a &quot;Cache-Control:
560 # public, max-age=[TTL]&quot; header, regardless of any existing
561 # Cache-Control header. The actual headers served in responses will not be
562 # altered.
563 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
564 &quot;A String&quot;,
565 ],
566 },
567 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
568 # the client&#x27;s Accept-Encoding header.
569 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
570 # text format.
571 &quot;customResponseHeaders&quot;: [ # Headers that the Application Load Balancer should add to proxied responses.
572 &quot;A String&quot;,
573 ],
574 &quot;description&quot;: &quot;A String&quot;, # An optional textual description of the resource; provided by the client
575 # when the resource is created.
576 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
577 # this backend bucket.
578 &quot;enableCdn&quot;: True or False, # If true, enable Cloud CDN for this BackendBucket.
579 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
580 &quot;kind&quot;: &quot;compute#backendBucket&quot;, # Output only. Type of the resource.
581 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # The value can only be INTERNAL_MANAGED for cross-region internal layer 7
582 # load balancer.
583 #
584 # If loadBalancingScheme is not specified, the backend bucket can be used by
585 # classic global external load balancers, or global application external load
586 # balancers, or both.
587 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
588 # The name must be 1-63 characters long, and comply withRFC1035.
589 # Specifically, the name must be 1-63 characters long and match the regular
590 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
591 # character must be a lowercase letter, and all following characters must
592 # be a dash, lowercase letter, or digit, except the last character, which
593 # cannot be a dash.
594 &quot;params&quot;: { # Additional Backend Bucket parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
595 # as part of resource payload.
596 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
597 # Tag keys and values have the same definition as resource
598 # manager tags. The field is allowed for INSERT
599 # only. The keys/values to set on the resource should be specified in
600 # either ID { : } or Namespaced format
601 # { : }.
602 # For example the following are valid inputs:
603 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
604 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
605 # Note:
606 # * Invalid combinations of ID &amp; namespaced format is not supported. For
607 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
608 &quot;a_key&quot;: &quot;A String&quot;,
609 },
610 },
611 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend bucket
612 # resides. This field is not applicable to global backend buckets.
613 # You must specify this field as part of the HTTP request URL. It is
614 # not settable as a field in the request body.
615 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
616 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing that backend bucket.
617 {
618 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for UrlMaps referencing that
619 # BackendBucket.
620 },
621 ],
622 }</pre>
623 </div>
624
625 <div class="method">
626 <code class="details" id="getIamPolicy">getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
627 <pre>Gets the access control policy for a resource. May be empty if no such
628 policy or resource exists.
629
630 Args:
631 project: string, Project ID for this request. (required)
632 region: string, The name of the region for this request. (required)
633 resource: string, Name or id of the resource for this request. (required)
634 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
635 x__xgafv: string, V1 error format.
636 Allowed values
637 1 - v1 error format
638 2 - v2 error format
639
640 Returns:
641 An object of the form:
642
643 { # An Identity and Access Management (IAM) policy, which specifies access
644 # controls for Google Cloud resources.
645 #
646 #
647 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
648 # `members`, or principals, to a single `role`. Principals can be user
649 # accounts, service accounts, Google groups, and domains (such as G Suite). A
650 # `role` is a named list of permissions; each `role` can be an IAM predefined
651 # role or a user-created custom role.
652 #
653 # For some types of Google Cloud resources, a `binding` can also specify a
654 # `condition`, which is a logical expression that allows access to a resource
655 # only if the expression evaluates to `true`. A condition can add constraints
656 # based on attributes of the request, the resource, or both. To learn which
657 # resources support conditions in their IAM policies, see the
658 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
659 #
660 # **JSON example:**
661 #
662 # ```
663 # {
664 # &quot;bindings&quot;: [
665 # {
666 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
667 # &quot;members&quot;: [
668 # &quot;user:[email protected]&quot;,
669 # &quot;group:[email protected]&quot;,
670 # &quot;domain:google.com&quot;,
671 # &quot;serviceAccount:[email protected]&quot;
672 # ]
673 # },
674 # {
675 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
676 # &quot;members&quot;: [
677 # &quot;user:[email protected]&quot;
678 # ],
679 # &quot;condition&quot;: {
680 # &quot;title&quot;: &quot;expirable access&quot;,
681 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
682 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
683 # }
684 # }
685 # ],
686 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
687 # &quot;version&quot;: 3
688 # }
689 # ```
690 #
691 # **YAML example:**
692 #
693 # ```
694 # bindings:
695 # - members:
696 # - user:[email protected]
697 # - group:[email protected]
698 # - domain:google.com
699 # - serviceAccount:[email protected]
700 # role: roles/resourcemanager.organizationAdmin
701 # - members:
702 # - user:[email protected]
703 # role: roles/resourcemanager.organizationViewer
704 # condition:
705 # title: expirable access
706 # description: Does not grant access after Sep 2020
707 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
708 # etag: BwWWja0YfJA=
709 # version: 3
710 # ```
711 #
712 # For a description of IAM and its features, see the
713 # [IAM documentation](https://cloud.google.com/iam/docs/).
714 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
715 { # Specifies the audit configuration for a service.
716 # The configuration determines which permission types are logged, and what
717 # identities, if any, are exempted from logging.
718 # An AuditConfig must have one or more AuditLogConfigs.
719 #
720 # If there are AuditConfigs for both `allServices` and a specific service,
721 # the union of the two AuditConfigs is used for that service: the log_types
722 # specified in each AuditConfig are enabled, and the exempted_members in each
723 # AuditLogConfig are exempted.
724 #
725 # Example Policy with multiple AuditConfigs:
726 #
727 # {
728 # &quot;audit_configs&quot;: [
729 # {
730 # &quot;service&quot;: &quot;allServices&quot;,
731 # &quot;audit_log_configs&quot;: [
732 # {
733 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
734 # &quot;exempted_members&quot;: [
735 # &quot;user:[email protected]&quot;
736 # ]
737 # },
738 # {
739 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
740 # },
741 # {
742 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
743 # }
744 # ]
745 # },
746 # {
747 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
748 # &quot;audit_log_configs&quot;: [
749 # {
750 # &quot;log_type&quot;: &quot;DATA_READ&quot;
751 # },
752 # {
753 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
754 # &quot;exempted_members&quot;: [
755 # &quot;user:[email protected]&quot;
756 # ]
757 # }
758 # ]
759 # }
760 # ]
761 # }
762 #
763 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
764 # logging. It also exempts `[email protected]` from DATA_READ logging, and
765 # `[email protected]` from DATA_WRITE logging.
766 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
767 { # Provides the configuration for logging a type of permissions.
768 # Example:
769 #
770 # {
771 # &quot;audit_log_configs&quot;: [
772 # {
773 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
774 # &quot;exempted_members&quot;: [
775 # &quot;user:[email protected]&quot;
776 # ]
777 # },
778 # {
779 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
780 # }
781 # ]
782 # }
783 #
784 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
785 # [email protected] from DATA_READ logging.
786 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
787 # permission.
788 # Follows the same format of Binding.members.
789 &quot;A String&quot;,
790 ],
791 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
792 },
793 ],
794 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
795 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
796 # `allServices` is a special value that covers all services.
797 },
798 ],
799 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
800 # may specify a `condition` that determines how and when the `bindings` are
801 # applied. Each of the `bindings` must contain at least one principal.
802 #
803 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
804 # of these principals can be Google groups. Each occurrence of a principal
805 # counts towards these limits. For example, if the `bindings` grant 50
806 # different roles to `user:[email protected]`, and not to any other
807 # principal, then you can add another 1,450 principals to the `bindings` in
808 # the `Policy`.
809 { # Associates `members`, or principals, with a `role`.
810 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
811 #
812 # If the condition evaluates to `true`, then this binding applies to the
813 # current request.
814 #
815 # If the condition evaluates to `false`, then this binding does not apply to
816 # the current request. However, a different role binding might grant the same
817 # role to one or more of the principals in this binding.
818 #
819 # To learn which resources support conditions in their IAM policies, see the
820 # [IAM
821 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
822 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
823 # are documented at https://github.com/google/cel-spec.
824 #
825 # Example (Comparison):
826 #
827 # title: &quot;Summary size limit&quot;
828 # description: &quot;Determines if a summary is less than 100 chars&quot;
829 # expression: &quot;document.summary.size() &lt; 100&quot;
830 #
831 # Example (Equality):
832 #
833 # title: &quot;Requestor is owner&quot;
834 # description: &quot;Determines if requestor is the document owner&quot;
835 # expression: &quot;document.owner == request.auth.claims.email&quot;
836 #
837 # Example (Logic):
838 #
839 # title: &quot;Public documents&quot;
840 # description: &quot;Determine whether the document should be publicly visible&quot;
841 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
842 #
843 # Example (Data Manipulation):
844 #
845 # title: &quot;Notification string&quot;
846 # description: &quot;Create a notification string with a timestamp.&quot;
847 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
848 #
849 # The exact variables and functions that may be referenced within an expression
850 # are determined by the service that evaluates it. See the service
851 # documentation for additional information.
852 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
853 # describes the expression, e.g. when hovered over it in a UI.
854 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
855 # syntax.
856 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
857 # reporting, e.g. a file name and a position in the file.
858 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
859 # its purpose. This can be used e.g. in UIs which allow to enter the
860 # expression.
861 },
862 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
863 # `members` can have the following values:
864 #
865 # * `allUsers`: A special identifier that represents anyone who is
866 # on the internet; with or without a Google account.
867 #
868 # * `allAuthenticatedUsers`: A special identifier that represents anyone
869 # who is authenticated with a Google account or a service account.
870 # Does not include identities that come from external identity providers
871 # (IdPs) through identity federation.
872 #
873 # * `user:{emailid}`: An email address that represents a specific Google
874 # account. For example, `[email protected]` .
875 #
876 #
877 # * `serviceAccount:{emailid}`: An email address that represents a Google
878 # service account. For example,
879 # `[email protected]`.
880 #
881 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
882 # identifier for a
883 # [Kubernetes service
884 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
885 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
886 #
887 # * `group:{emailid}`: An email address that represents a Google group.
888 # For example, `[email protected]`.
889 #
890 #
891 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
892 # users of that domain. For example, `google.com` or `example.com`.
893 #
894 #
895 #
896 #
897 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
898 # A single identity in a workforce identity pool.
899 #
900 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
901 # All workforce identities in a group.
902 #
903 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
904 # All workforce identities with a specific attribute value.
905 #
906 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
907 # All identities in a workforce identity pool.
908 #
909 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
910 # A single identity in a workload identity pool.
911 #
912 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
913 # A workload identity pool group.
914 #
915 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
916 # All identities in a workload identity pool with a certain attribute.
917 #
918 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
919 # All identities in a workload identity pool.
920 #
921 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
922 # identifier) representing a user that has been recently deleted. For
923 # example, `[email protected]?uid=123456789012345678901`. If the user is
924 # recovered, this value reverts to `user:{emailid}` and the recovered user
925 # retains the role in the binding.
926 #
927 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
928 # unique identifier) representing a service account that has been recently
929 # deleted. For example,
930 # `[email protected]?uid=123456789012345678901`.
931 # If the service account is undeleted, this value reverts to
932 # `serviceAccount:{emailid}` and the undeleted service account retains the
933 # role in the binding.
934 #
935 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
936 # identifier) representing a Google group that has been recently
937 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
938 # the group is recovered, this value reverts to `group:{emailid}` and the
939 # recovered group retains the role in the binding.
940 #
941 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
942 # Deleted single identity in a workforce identity pool. For example,
943 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
944 &quot;A String&quot;,
945 ],
946 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
947 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
948 #
949 # For an overview of the IAM roles and permissions, see the
950 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
951 # a list of the available pre-defined roles, see
952 # [here](https://cloud.google.com/iam/docs/understanding-roles).
953 },
954 ],
955 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
956 # prevent simultaneous updates of a policy from overwriting each other.
957 # It is strongly suggested that systems make use of the `etag` in the
958 # read-modify-write cycle to perform policy updates in order to avoid race
959 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
960 # systems are expected to put that etag in the request to `setIamPolicy` to
961 # ensure that their change will be applied to the same version of the policy.
962 #
963 # **Important:** If you use IAM Conditions, you must include the `etag` field
964 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
965 # you to overwrite a version `3` policy with a version `1` policy, and all of
966 # the conditions in the version `3` policy are lost.
967 &quot;version&quot;: 42, # Specifies the format of the policy.
968 #
969 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
970 # are rejected.
971 #
972 # Any operation that affects conditional role bindings must specify version
973 # `3`. This requirement applies to the following operations:
974 #
975 # * Getting a policy that includes a conditional role binding
976 # * Adding a conditional role binding to a policy
977 # * Changing a conditional role binding in a policy
978 # * Removing any role binding, with or without a condition, from a policy
979 # that includes conditions
980 #
981 # **Important:** If you use IAM Conditions, you must include the `etag` field
982 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
983 # you to overwrite a version `3` policy with a version `1` policy, and all of
984 # the conditions in the version `3` policy are lost.
985 #
986 # If a policy does not include any conditions, operations on that policy may
987 # specify any valid version or leave the field unset.
988 #
989 # To learn which resources support conditions in their IAM policies, see the
990 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
991 }</pre>
992 </div>
993
994 <div class="method">
995 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code>
996 <pre>Creates a RegionBackendBucket in the specified project in the given scope
997 using the parameters that are included in the request.
998
999 Args:
1000 project: string, Project ID for this request. (required)
1001 region: string, Name of the region of this request. (required)
1002 body: object, The request body.
1003 The object takes the form of:
1004
1005 { # Represents a Cloud Storage Bucket resource.
1006 #
1007 # This Cloud Storage bucket resource is referenced by a URL map of a load
1008 # balancer. For more information, readBackend Buckets.
1009 &quot;bucketName&quot;: &quot;A String&quot;, # Cloud Storage bucket name.
1010 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket.
1011 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
1012 # Pragma or Authorization headers. Up to 5 headers can be specified.
1013 # The cache is bypassed for all cdnPolicy.cacheMode settings.
1014 { # Bypass the cache when the specified request headers are present,
1015 # e.g. Pragma or Authorization headers. Values are case insensitive.
1016 # The presence of such a header overrides the cache_mode setting.
1017 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
1018 # Values are case-insensitive.
1019 },
1020 ],
1021 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for # The CacheKeyPolicy for this CdnPolicy.
1022 # Cloud CDN.
1023 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
1024 &quot;A String&quot;,
1025 ],
1026 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. Default
1027 # parameters are always included. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded
1028 # and not treated as delimiters.
1029 &quot;A String&quot;,
1030 ],
1031 },
1032 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
1033 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
1034 # headers to cache content. Responses without these headers will not be
1035 # cached at Google&#x27;s edge, and will require a full trip to the origin on
1036 # every request, potentially impacting performance and increasing load on
1037 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
1038 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
1039 # Warning: this may result in Cloud CDN caching private,
1040 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
1041 # including common image formats, media (video and audio), and web assets
1042 # (JavaScript and CSS). Requests and responses that are marked as
1043 # uncacheable, as well as dynamic content (including HTML), will not be
1044 # cached.
1045 #
1046 # If no value is provided for cdnPolicy.cacheMode, it defaults
1047 # to CACHE_ALL_STATIC.
1048 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
1049 # used to clamp the max-age (or Expires) value sent to the client. With
1050 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
1051 # response max-age directive, along with a &quot;public&quot; directive. For
1052 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
1053 # from the origin (if specified), or else sets the response max-age
1054 # directive to the lesser of the client_ttl and default_ttl, and also
1055 # ensures a &quot;public&quot; cache-control directive is present.
1056 # If a client TTL is not specified, a default value (1 hour) will be used.
1057 # The maximum allowed value is 31,622,400s (1 year).
1058 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
1059 # responses that do not have an existing valid TTL (max-age or s-maxage).
1060 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
1061 # The value of defaultTTL cannot be set to a value greater than that of
1062 # maxTTL, but can be equal.
1063 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
1064 # will overwrite the TTL set in all responses. The maximum allowed value is
1065 # 31,622,400s (1 year), noting that infrequently accessed objects may be
1066 # evicted from the cache before the defined TTL.
1067 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
1068 # origin.
1069 # Cache directives that attempt to set a max-age or s-maxage higher than
1070 # this, or an Expires header more than maxTTL seconds in the future will
1071 # be capped at the value of maxTTL, as if it were the value of an
1072 # s-maxage Cache-Control directive.
1073 # Headers sent to the client will not be modified.
1074 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
1075 # The maximum allowed value is 31,622,400s (1 year), noting that
1076 # infrequently accessed objects may be evicted from the cache before
1077 # the defined TTL.
1078 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
1079 # to apply fine-grained caching for common errors or redirects.
1080 # This can reduce the load on your origin and improve end-user
1081 # experience by reducing response latency.
1082 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
1083 # negative caching applies to responses with the specified response code
1084 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
1085 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
1086 # to all responses with the specified response code, and override any
1087 # caching headers.
1088 # By default, Cloud CDN will apply the following default TTLs to these
1089 # status codes:
1090 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
1091 # HTTP 404 (Not Found), 410 (Gone),
1092 # 451 (Unavailable For Legal Reasons): 120s
1093 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
1094 # These defaults can be overridden in negative_caching_policy.
1095 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
1096 # negative_caching must be enabled to configure negative_caching_policy.
1097 # Omitting the policy and leaving negative_caching enabled will use
1098 # Cloud CDN&#x27;s default cache TTLs.
1099 # Note that when specifying an explicit negative_caching_policy, you
1100 # should take care to specify a cache TTL for all response codes
1101 # that you wish to cache. Cloud CDN will not apply any default
1102 # negative caching when a policy exists.
1103 { # Specify CDN TTLs for response error codes.
1104 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
1105 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
1106 # specified as values, and you cannot specify a status code more than
1107 # once.
1108 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
1109 # corresponding status code.
1110 # The maximum allowed value is 1800s (30 minutes), noting that
1111 # infrequently accessed objects may be evicted from the cache before the
1112 # defined TTL.
1113 },
1114 ],
1115 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
1116 # requests into a small number of requests to the origin.
1117 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
1118 # content with the origin, or when an error is encountered when refreshing
1119 # the cache.
1120 # This setting defines the default &quot;max-stale&quot; duration for any cached
1121 # responses that do not specify a max-stale directive. Stale responses that
1122 # exceed the TTL configured here will not be served. The default limit
1123 # (max-stale) is 86400s (1 day), which will allow stale content to be
1124 # served up to this limit beyond the max-age (or s-maxage) of a cached
1125 # response.
1126 # The maximum allowed value is 604800 (1 week).
1127 # Set this to zero (0) to disable serve-while-stale.
1128 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
1129 # considered fresh. After this time period, the response will be
1130 # revalidated before being served. Defaults to 1hr (3600s). When serving
1131 # responses to signed URL requests, Cloud CDN will internally behave as
1132 # though all responses from this backend had a &quot;Cache-Control:
1133 # public, max-age=[TTL]&quot; header, regardless of any existing
1134 # Cache-Control header. The actual headers served in responses will not be
1135 # altered.
1136 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
1137 &quot;A String&quot;,
1138 ],
1139 },
1140 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
1141 # the client&#x27;s Accept-Encoding header.
1142 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
1143 # text format.
1144 &quot;customResponseHeaders&quot;: [ # Headers that the Application Load Balancer should add to proxied responses.
1145 &quot;A String&quot;,
1146 ],
1147 &quot;description&quot;: &quot;A String&quot;, # An optional textual description of the resource; provided by the client
1148 # when the resource is created.
1149 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
1150 # this backend bucket.
1151 &quot;enableCdn&quot;: True or False, # If true, enable Cloud CDN for this BackendBucket.
1152 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1153 &quot;kind&quot;: &quot;compute#backendBucket&quot;, # Output only. Type of the resource.
1154 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # The value can only be INTERNAL_MANAGED for cross-region internal layer 7
1155 # load balancer.
1156 #
1157 # If loadBalancingScheme is not specified, the backend bucket can be used by
1158 # classic global external load balancers, or global application external load
1159 # balancers, or both.
1160 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1161 # The name must be 1-63 characters long, and comply withRFC1035.
1162 # Specifically, the name must be 1-63 characters long and match the regular
1163 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1164 # character must be a lowercase letter, and all following characters must
1165 # be a dash, lowercase letter, or digit, except the last character, which
1166 # cannot be a dash.
1167 &quot;params&quot;: { # Additional Backend Bucket parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
1168 # as part of resource payload.
1169 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
1170 # Tag keys and values have the same definition as resource
1171 # manager tags. The field is allowed for INSERT
1172 # only. The keys/values to set on the resource should be specified in
1173 # either ID { : } or Namespaced format
1174 # { : }.
1175 # For example the following are valid inputs:
1176 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
1177 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
1178 # Note:
1179 # * Invalid combinations of ID &amp; namespaced format is not supported. For
1180 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
1181 &quot;a_key&quot;: &quot;A String&quot;,
1182 },
1183 },
1184 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend bucket
1185 # resides. This field is not applicable to global backend buckets.
1186 # You must specify this field as part of the HTTP request URL. It is
1187 # not settable as a field in the request body.
1188 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1189 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing that backend bucket.
1190 {
1191 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for UrlMaps referencing that
1192 # BackendBucket.
1193 },
1194 ],
1195 }
1196
1197 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1198 that if you must retry your request, the server will know to ignore the
1199 request if it has already been completed.
1200
1201 For example, consider a situation where you make an initial request and
1202 the request times out. If you make the request again with the same
1203 request ID, the server can check if original operation with the same
1204 request ID was received, and if so, will ignore the second request. This
1205 prevents clients from accidentally creating duplicate commitments.
1206
1207 The request ID must be
1208 a valid UUID with the exception that zero UUID is not supported
1209 (00000000-0000-0000-0000-000000000000).
1210 x__xgafv: string, V1 error format.
1211 Allowed values
1212 1 - v1 error format
1213 2 - v2 error format
1214
1215 Returns:
1216 An object of the form:
1217
1218 { # Represents an Operation resource.
1219 #
1220 # Google Compute Engine has three Operation resources:
1221 #
1222 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
1223 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
1224 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
1225 #
1226 # You can use an operation resource to manage asynchronous API requests.
1227 # For more information, readHandling
1228 # API responses.
1229 #
1230 # Operations can be global, regional or zonal.
1231 #
1232 # - For global operations, use the `globalOperations`
1233 # resource.
1234 # - For regional operations, use the
1235 # `regionOperations` resource.
1236 # - For zonal operations, use
1237 # the `zoneOperations` resource.
1238 #
1239 #
1240 #
1241 # For more information, read
1242 # Global, Regional, and Zonal Resources.
1243 #
1244 # Note that completed Operation resources have a limited
1245 # retention period.
1246 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1247 # Not present otherwise.
1248 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1249 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1250 # set when the operation is created.
1251 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1252 # text format.
1253 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1254 # this field will be populated.
1255 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1256 # operation.
1257 {
1258 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1259 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1260 # details. There is a set of defined message types to use for providing
1261 # details.The syntax depends on the error code. For example,
1262 # QuotaExceededInfo will have details when the error code is
1263 # QUOTA_EXCEEDED.
1264 {
1265 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1266 #
1267 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1268 # is not enabled:
1269 #
1270 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1271 # &quot;domain&quot;: &quot;googleapis.com&quot;
1272 # &quot;metadata&quot;: {
1273 # &quot;resource&quot;: &quot;projects/123&quot;,
1274 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1275 # }
1276 # }
1277 #
1278 # This response indicates that the pubsub.googleapis.com API is not enabled.
1279 #
1280 # Example of an error that is returned when attempting to create a Spanner
1281 # instance in a region that is out of stock:
1282 #
1283 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1284 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1285 # &quot;metadata&quot;: {
1286 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1287 # }
1288 # }
1289 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1290 # is typically the registered service name of the tool or product that
1291 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1292 # generated by some common infrastructure, the error domain must be a
1293 # globally unique value that identifies the infrastructure. For Google API
1294 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1295 &quot;metadatas&quot;: { # Additional structured details about this error.
1296 #
1297 # Keys must match a regular expression of `a-z+` but should
1298 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1299 # length. When identifying the current value of an exceeded limit, the units
1300 # should be contained in the key, not the value. For example, rather than
1301 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1302 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1303 # instances that can be created in a single (batch) request.
1304 &quot;a_key&quot;: &quot;A String&quot;,
1305 },
1306 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1307 # proximate cause of the error. Error reasons are unique within a particular
1308 # domain of errors. This should be at most 63 characters and match a
1309 # regular expression of `A-Z+[A-Z0-9]`, which represents
1310 # UPPER_SNAKE_CASE.
1311 },
1312 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1313 #
1314 # For example, if a quota check failed with an error indicating the calling
1315 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1316 # directly to the right place in the developer console to flip the bit.
1317 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1318 { # Describes a URL link.
1319 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1320 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1321 },
1322 ],
1323 },
1324 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1325 # which can be attached to an RPC error.
1326 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1327 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1328 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1329 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1330 },
1331 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1332 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1333 &quot;a_key&quot;: &quot;A String&quot;,
1334 },
1335 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1336 # type or metric.
1337 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1338 # or metric.
1339 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1340 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1341 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1342 },
1343 },
1344 ],
1345 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1346 # This property is optional.
1347 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1348 },
1349 ],
1350 },
1351 &quot;getVersionOperationMetadata&quot;: {
1352 &quot;inlineSbomInfo&quot;: {
1353 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1354 # appropriate identifiers.
1355 &quot;a_key&quot;: &quot;A String&quot;,
1356 },
1357 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1358 # identifiers.
1359 &quot;a_key&quot;: &quot;A String&quot;,
1360 },
1361 },
1362 },
1363 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1364 # message that was returned, such as `NOT FOUND`.
1365 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1366 # status code that was returned. For example, a `404` means the
1367 # resource was not found.
1368 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1369 # defined by the server.
1370 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1371 # This value is inRFC3339
1372 # text format.
1373 &quot;instancesBulkInsertOperationMetadata&quot;: {
1374 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1375 # Example key: zones/us-central1-a
1376 &quot;a_key&quot;: {
1377 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1378 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1379 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1380 # error.
1381 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1382 # if the flow is rolling forward or rolling back.
1383 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1384 },
1385 },
1386 },
1387 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1388 # Operation resources.
1389 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1390 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1391 # group of operations results from a `bulkInsert` API request.
1392 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1393 # `update`, or `delete`, and so on.
1394 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1395 # There is no requirement that this be linear or support any granularity of
1396 # operations. This should not be used to guess when the operation will be
1397 # complete. This number should monotonically increase as the operation
1398 # progresses.
1399 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1400 # applicable when performing regional operations.
1401 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1402 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1403 # this field will contain information on all underlying zonal actions and
1404 # their state.
1405 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1406 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1407 # Example key: zones/us-central1-a
1408 &quot;a_key&quot;: {
1409 &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
1410 # populated.
1411 # different programming environments, including REST APIs and RPC APIs. It is
1412 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1413 # three pieces of data: error code, error message, and error details.
1414 #
1415 # You can find out more about this error model and how to work with it in the
1416 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1417 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1418 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1419 # message types for APIs to use.
1420 {
1421 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1422 },
1423 ],
1424 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1425 # user-facing error message should be localized and sent in the
1426 # google.rpc.Status.details field, or localized by the client.
1427 },
1428 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1429 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1430 },
1431 },
1432 },
1433 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1434 # This value is inRFC3339
1435 # text format.
1436 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1437 # following:
1438 # `PENDING`, `RUNNING`, or `DONE`.
1439 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1440 # operation.
1441 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1442 # of the target resource.
1443 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1444 # operations related to creating a snapshot, this points to the disk
1445 # that the snapshot was created from.
1446 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1447 # `[email protected]` or
1448 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1449 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1450 # operation, this field will be populated.
1451 {
1452 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1453 # Engine returns NO_RESULTS_ON_PAGE if there
1454 # are no results in the response.
1455 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1456 # value format. For example:
1457 #
1458 # &quot;data&quot;: [
1459 # {
1460 # &quot;key&quot;: &quot;scope&quot;,
1461 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1462 # }
1463 {
1464 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1465 # returned. For example, for warnings where there are no results in a list
1466 # request for a particular zone, this key might be scope and
1467 # the key value might be the zone name. Other examples might be a key
1468 # indicating a deprecated resource and a suggested replacement, or a
1469 # warning about invalid network settings (for example, if an instance
1470 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1471 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1472 },
1473 ],
1474 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1475 },
1476 ],
1477 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1478 # applicable when performing per-zone operations.
1479 }</pre>
1480 </div>
1481
1482 <div class="method">
1483 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
1484 <pre>Retrieves the list of BackendBucket resources available to the specified
1485 project in the given region.
1486
1487 Args:
1488 project: string, Project ID for this request. (required)
1489 region: string, Name of the region of this request. (required)
1490 filter: string, A filter expression that filters resources listed in the response. Most
1491 Compute resources support two types of filter expressions:
1492 expressions that support regular expressions and expressions that follow
1493 API improvement proposal AIP-160.
1494 These two types of filter expressions cannot be mixed in one request.
1495
1496 If you want to use AIP-160, your expression must specify the field name, an
1497 operator, and the value that you want to use for filtering. The value
1498 must be a string, a number, or a boolean. The operator
1499 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1500
1501 For example, if you are filtering Compute Engine instances, you can
1502 exclude instances named `example-instance` by specifying
1503 `name != example-instance`.
1504
1505 The `:*` comparison can be used to test whether a key has been defined.
1506 For example, to find all objects with `owner` label use:
1507 ```
1508 labels.owner:*
1509 ```
1510
1511 You can also filter nested fields. For example, you could specify
1512 `scheduling.automaticRestart = false` to include instances only
1513 if they are not scheduled for automatic restarts. You can use filtering
1514 on nested fields to filter based onresource labels.
1515
1516 To filter on multiple expressions, provide each separate expression within
1517 parentheses. For example:
1518 ```
1519 (scheduling.automaticRestart = true)
1520 (cpuPlatform = &quot;Intel Skylake&quot;)
1521 ```
1522 By default, each expression is an `AND` expression. However, you
1523 can include `AND` and `OR` expressions explicitly.
1524 For example:
1525 ```
1526 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1527 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1528 (scheduling.automaticRestart = true)
1529 ```
1530
1531 If you want to use a regular expression, use the `eq` (equal) or `ne`
1532 (not equal) operator against a single un-parenthesized expression with or
1533 without quotes or against multiple parenthesized expressions. Examples:
1534
1535 `fieldname eq unquoted literal`
1536 `fieldname eq &#x27;single quoted literal&#x27;`
1537 `fieldname eq &quot;double quoted literal&quot;`
1538 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1539
1540 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1541 The literal value must match the entire field.
1542
1543 For example, to filter for instances that do not end with name &quot;instance&quot;,
1544 you would use `name ne .*instance`.
1545
1546 You cannot combine constraints on multiple fields using regular
1547 expressions.
1548 maxResults: integer, The maximum number of results per page that should be returned.
1549 If the number of available results is larger than `maxResults`,
1550 Compute Engine returns a `nextPageToken` that can be used to get
1551 the next page of results in subsequent list requests. Acceptable values are
1552 `0` to `500`, inclusive. (Default: `500`)
1553 orderBy: string, Sorts list results by a certain order. By default, results
1554 are returned in alphanumerical order based on the resource name.
1555
1556 You can also sort results in descending order based on the creation
1557 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1558 results based on the `creationTimestamp` field in
1559 reverse chronological order (newest result first). Use this to sort
1560 resources like operations so that the newest operation is returned first.
1561
1562 Currently, only sorting by `name` or
1563 `creationTimestamp desc` is supported.
1564 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1565 `nextPageToken` returned by a previous list request to get
1566 the next page of results.
1567 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1568 of failure. The default value is false.
1569
1570 For example, when partial success behavior is enabled, aggregatedList for a
1571 single zone scope either returns all resources in the zone or no resources,
1572 with an error code.
1573 x__xgafv: string, V1 error format.
1574 Allowed values
1575 1 - v1 error format
1576 2 - v2 error format
1577
1578 Returns:
1579 An object of the form:
1580
1581 { # Contains a list of BackendBucket resources.
1582 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1583 &quot;items&quot;: [ # A list of BackendBucket resources.
1584 { # Represents a Cloud Storage Bucket resource.
1585 #
1586 # This Cloud Storage bucket resource is referenced by a URL map of a load
1587 # balancer. For more information, readBackend Buckets.
1588 &quot;bucketName&quot;: &quot;A String&quot;, # Cloud Storage bucket name.
1589 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket.
1590 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
1591 # Pragma or Authorization headers. Up to 5 headers can be specified.
1592 # The cache is bypassed for all cdnPolicy.cacheMode settings.
1593 { # Bypass the cache when the specified request headers are present,
1594 # e.g. Pragma or Authorization headers. Values are case insensitive.
1595 # The presence of such a header overrides the cache_mode setting.
1596 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
1597 # Values are case-insensitive.
1598 },
1599 ],
1600 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for # The CacheKeyPolicy for this CdnPolicy.
1601 # Cloud CDN.
1602 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
1603 &quot;A String&quot;,
1604 ],
1605 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. Default
1606 # parameters are always included. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded
1607 # and not treated as delimiters.
1608 &quot;A String&quot;,
1609 ],
1610 },
1611 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
1612 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
1613 # headers to cache content. Responses without these headers will not be
1614 # cached at Google&#x27;s edge, and will require a full trip to the origin on
1615 # every request, potentially impacting performance and increasing load on
1616 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
1617 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
1618 # Warning: this may result in Cloud CDN caching private,
1619 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
1620 # including common image formats, media (video and audio), and web assets
1621 # (JavaScript and CSS). Requests and responses that are marked as
1622 # uncacheable, as well as dynamic content (including HTML), will not be
1623 # cached.
1624 #
1625 # If no value is provided for cdnPolicy.cacheMode, it defaults
1626 # to CACHE_ALL_STATIC.
1627 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
1628 # used to clamp the max-age (or Expires) value sent to the client. With
1629 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
1630 # response max-age directive, along with a &quot;public&quot; directive. For
1631 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
1632 # from the origin (if specified), or else sets the response max-age
1633 # directive to the lesser of the client_ttl and default_ttl, and also
1634 # ensures a &quot;public&quot; cache-control directive is present.
1635 # If a client TTL is not specified, a default value (1 hour) will be used.
1636 # The maximum allowed value is 31,622,400s (1 year).
1637 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
1638 # responses that do not have an existing valid TTL (max-age or s-maxage).
1639 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
1640 # The value of defaultTTL cannot be set to a value greater than that of
1641 # maxTTL, but can be equal.
1642 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
1643 # will overwrite the TTL set in all responses. The maximum allowed value is
1644 # 31,622,400s (1 year), noting that infrequently accessed objects may be
1645 # evicted from the cache before the defined TTL.
1646 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
1647 # origin.
1648 # Cache directives that attempt to set a max-age or s-maxage higher than
1649 # this, or an Expires header more than maxTTL seconds in the future will
1650 # be capped at the value of maxTTL, as if it were the value of an
1651 # s-maxage Cache-Control directive.
1652 # Headers sent to the client will not be modified.
1653 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
1654 # The maximum allowed value is 31,622,400s (1 year), noting that
1655 # infrequently accessed objects may be evicted from the cache before
1656 # the defined TTL.
1657 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
1658 # to apply fine-grained caching for common errors or redirects.
1659 # This can reduce the load on your origin and improve end-user
1660 # experience by reducing response latency.
1661 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
1662 # negative caching applies to responses with the specified response code
1663 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
1664 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
1665 # to all responses with the specified response code, and override any
1666 # caching headers.
1667 # By default, Cloud CDN will apply the following default TTLs to these
1668 # status codes:
1669 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
1670 # HTTP 404 (Not Found), 410 (Gone),
1671 # 451 (Unavailable For Legal Reasons): 120s
1672 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
1673 # These defaults can be overridden in negative_caching_policy.
1674 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
1675 # negative_caching must be enabled to configure negative_caching_policy.
1676 # Omitting the policy and leaving negative_caching enabled will use
1677 # Cloud CDN&#x27;s default cache TTLs.
1678 # Note that when specifying an explicit negative_caching_policy, you
1679 # should take care to specify a cache TTL for all response codes
1680 # that you wish to cache. Cloud CDN will not apply any default
1681 # negative caching when a policy exists.
1682 { # Specify CDN TTLs for response error codes.
1683 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
1684 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
1685 # specified as values, and you cannot specify a status code more than
1686 # once.
1687 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
1688 # corresponding status code.
1689 # The maximum allowed value is 1800s (30 minutes), noting that
1690 # infrequently accessed objects may be evicted from the cache before the
1691 # defined TTL.
1692 },
1693 ],
1694 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
1695 # requests into a small number of requests to the origin.
1696 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
1697 # content with the origin, or when an error is encountered when refreshing
1698 # the cache.
1699 # This setting defines the default &quot;max-stale&quot; duration for any cached
1700 # responses that do not specify a max-stale directive. Stale responses that
1701 # exceed the TTL configured here will not be served. The default limit
1702 # (max-stale) is 86400s (1 day), which will allow stale content to be
1703 # served up to this limit beyond the max-age (or s-maxage) of a cached
1704 # response.
1705 # The maximum allowed value is 604800 (1 week).
1706 # Set this to zero (0) to disable serve-while-stale.
1707 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
1708 # considered fresh. After this time period, the response will be
1709 # revalidated before being served. Defaults to 1hr (3600s). When serving
1710 # responses to signed URL requests, Cloud CDN will internally behave as
1711 # though all responses from this backend had a &quot;Cache-Control:
1712 # public, max-age=[TTL]&quot; header, regardless of any existing
1713 # Cache-Control header. The actual headers served in responses will not be
1714 # altered.
1715 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
1716 &quot;A String&quot;,
1717 ],
1718 },
1719 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
1720 # the client&#x27;s Accept-Encoding header.
1721 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
1722 # text format.
1723 &quot;customResponseHeaders&quot;: [ # Headers that the Application Load Balancer should add to proxied responses.
1724 &quot;A String&quot;,
1725 ],
1726 &quot;description&quot;: &quot;A String&quot;, # An optional textual description of the resource; provided by the client
1727 # when the resource is created.
1728 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
1729 # this backend bucket.
1730 &quot;enableCdn&quot;: True or False, # If true, enable Cloud CDN for this BackendBucket.
1731 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1732 &quot;kind&quot;: &quot;compute#backendBucket&quot;, # Output only. Type of the resource.
1733 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # The value can only be INTERNAL_MANAGED for cross-region internal layer 7
1734 # load balancer.
1735 #
1736 # If loadBalancingScheme is not specified, the backend bucket can be used by
1737 # classic global external load balancers, or global application external load
1738 # balancers, or both.
1739 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1740 # The name must be 1-63 characters long, and comply withRFC1035.
1741 # Specifically, the name must be 1-63 characters long and match the regular
1742 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1743 # character must be a lowercase letter, and all following characters must
1744 # be a dash, lowercase letter, or digit, except the last character, which
1745 # cannot be a dash.
1746 &quot;params&quot;: { # Additional Backend Bucket parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
1747 # as part of resource payload.
1748 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
1749 # Tag keys and values have the same definition as resource
1750 # manager tags. The field is allowed for INSERT
1751 # only. The keys/values to set on the resource should be specified in
1752 # either ID { : } or Namespaced format
1753 # { : }.
1754 # For example the following are valid inputs:
1755 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
1756 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
1757 # Note:
1758 # * Invalid combinations of ID &amp; namespaced format is not supported. For
1759 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
1760 &quot;a_key&quot;: &quot;A String&quot;,
1761 },
1762 },
1763 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend bucket
1764 # resides. This field is not applicable to global backend buckets.
1765 # You must specify this field as part of the HTTP request URL. It is
1766 # not settable as a field in the request body.
1767 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1768 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing that backend bucket.
1769 {
1770 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for UrlMaps referencing that
1771 # BackendBucket.
1772 },
1773 ],
1774 },
1775 ],
1776 &quot;kind&quot;: &quot;compute#backendBucketList&quot;, # Output only. Type of resource.
1777 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
1778 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1779 # the query parameter pageToken in the next list request.
1780 # Subsequent list requests will have their own nextPageToken to
1781 # continue paging through the results.
1782 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
1783 &quot;warning&quot;: { # [Output Only] Informational warning message.
1784 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1785 # Engine returns NO_RESULTS_ON_PAGE if there
1786 # are no results in the response.
1787 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1788 # value format. For example:
1789 #
1790 # &quot;data&quot;: [
1791 # {
1792 # &quot;key&quot;: &quot;scope&quot;,
1793 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1794 # }
1795 {
1796 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1797 # returned. For example, for warnings where there are no results in a list
1798 # request for a particular zone, this key might be scope and
1799 # the key value might be the zone name. Other examples might be a key
1800 # indicating a deprecated resource and a suggested replacement, or a
1801 # warning about invalid network settings (for example, if an instance
1802 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1803 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1804 },
1805 ],
1806 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1807 },
1808 }</pre>
1809 </div>
1810
1811 <div class="method">
1812 <code class="details" id="listUsable">listUsable(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
1813 <pre>Retrieves a list of all usable backend buckets in the specified project in
1814 the given region.
1815
1816 Args:
1817 project: string, Project ID for this request. (required)
1818 region: string, Name of the region scoping this request.
1819 It must be a string that meets the requirements in RFC1035. (required)
1820 filter: string, A filter expression that filters resources listed in the response. Most
1821 Compute resources support two types of filter expressions:
1822 expressions that support regular expressions and expressions that follow
1823 API improvement proposal AIP-160.
1824 These two types of filter expressions cannot be mixed in one request.
1825
1826 If you want to use AIP-160, your expression must specify the field name, an
1827 operator, and the value that you want to use for filtering. The value
1828 must be a string, a number, or a boolean. The operator
1829 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1830
1831 For example, if you are filtering Compute Engine instances, you can
1832 exclude instances named `example-instance` by specifying
1833 `name != example-instance`.
1834
1835 The `:*` comparison can be used to test whether a key has been defined.
1836 For example, to find all objects with `owner` label use:
1837 ```
1838 labels.owner:*
1839 ```
1840
1841 You can also filter nested fields. For example, you could specify
1842 `scheduling.automaticRestart = false` to include instances only
1843 if they are not scheduled for automatic restarts. You can use filtering
1844 on nested fields to filter based onresource labels.
1845
1846 To filter on multiple expressions, provide each separate expression within
1847 parentheses. For example:
1848 ```
1849 (scheduling.automaticRestart = true)
1850 (cpuPlatform = &quot;Intel Skylake&quot;)
1851 ```
1852 By default, each expression is an `AND` expression. However, you
1853 can include `AND` and `OR` expressions explicitly.
1854 For example:
1855 ```
1856 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1857 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1858 (scheduling.automaticRestart = true)
1859 ```
1860
1861 If you want to use a regular expression, use the `eq` (equal) or `ne`
1862 (not equal) operator against a single un-parenthesized expression with or
1863 without quotes or against multiple parenthesized expressions. Examples:
1864
1865 `fieldname eq unquoted literal`
1866 `fieldname eq &#x27;single quoted literal&#x27;`
1867 `fieldname eq &quot;double quoted literal&quot;`
1868 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1869
1870 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1871 The literal value must match the entire field.
1872
1873 For example, to filter for instances that do not end with name &quot;instance&quot;,
1874 you would use `name ne .*instance`.
1875
1876 You cannot combine constraints on multiple fields using regular
1877 expressions.
1878 maxResults: integer, The maximum number of results per page that should be returned.
1879 If the number of available results is larger than `maxResults`,
1880 Compute Engine returns a `nextPageToken` that can be used to get
1881 the next page of results in subsequent list requests. Acceptable values are
1882 `0` to `500`, inclusive. (Default: `500`)
1883 orderBy: string, Sorts list results by a certain order. By default, results
1884 are returned in alphanumerical order based on the resource name.
1885
1886 You can also sort results in descending order based on the creation
1887 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1888 results based on the `creationTimestamp` field in
1889 reverse chronological order (newest result first). Use this to sort
1890 resources like operations so that the newest operation is returned first.
1891
1892 Currently, only sorting by `name` or
1893 `creationTimestamp desc` is supported.
1894 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1895 `nextPageToken` returned by a previous list request to get
1896 the next page of results.
1897 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1898 of failure. The default value is false.
1899
1900 For example, when partial success behavior is enabled, aggregatedList for a
1901 single zone scope either returns all resources in the zone or no resources,
1902 with an error code.
1903 x__xgafv: string, V1 error format.
1904 Allowed values
1905 1 - v1 error format
1906 2 - v2 error format
1907
1908 Returns:
1909 An object of the form:
1910
1911 {
1912 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1913 &quot;items&quot;: [ # A list of BackendBucket resources.
1914 { # Represents a Cloud Storage Bucket resource.
1915 #
1916 # This Cloud Storage bucket resource is referenced by a URL map of a load
1917 # balancer. For more information, readBackend Buckets.
1918 &quot;bucketName&quot;: &quot;A String&quot;, # Cloud Storage bucket name.
1919 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket.
1920 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
1921 # Pragma or Authorization headers. Up to 5 headers can be specified.
1922 # The cache is bypassed for all cdnPolicy.cacheMode settings.
1923 { # Bypass the cache when the specified request headers are present,
1924 # e.g. Pragma or Authorization headers. Values are case insensitive.
1925 # The presence of such a header overrides the cache_mode setting.
1926 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
1927 # Values are case-insensitive.
1928 },
1929 ],
1930 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for # The CacheKeyPolicy for this CdnPolicy.
1931 # Cloud CDN.
1932 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
1933 &quot;A String&quot;,
1934 ],
1935 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. Default
1936 # parameters are always included. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded
1937 # and not treated as delimiters.
1938 &quot;A String&quot;,
1939 ],
1940 },
1941 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
1942 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
1943 # headers to cache content. Responses without these headers will not be
1944 # cached at Google&#x27;s edge, and will require a full trip to the origin on
1945 # every request, potentially impacting performance and increasing load on
1946 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
1947 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
1948 # Warning: this may result in Cloud CDN caching private,
1949 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
1950 # including common image formats, media (video and audio), and web assets
1951 # (JavaScript and CSS). Requests and responses that are marked as
1952 # uncacheable, as well as dynamic content (including HTML), will not be
1953 # cached.
1954 #
1955 # If no value is provided for cdnPolicy.cacheMode, it defaults
1956 # to CACHE_ALL_STATIC.
1957 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
1958 # used to clamp the max-age (or Expires) value sent to the client. With
1959 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
1960 # response max-age directive, along with a &quot;public&quot; directive. For
1961 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
1962 # from the origin (if specified), or else sets the response max-age
1963 # directive to the lesser of the client_ttl and default_ttl, and also
1964 # ensures a &quot;public&quot; cache-control directive is present.
1965 # If a client TTL is not specified, a default value (1 hour) will be used.
1966 # The maximum allowed value is 31,622,400s (1 year).
1967 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
1968 # responses that do not have an existing valid TTL (max-age or s-maxage).
1969 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
1970 # The value of defaultTTL cannot be set to a value greater than that of
1971 # maxTTL, but can be equal.
1972 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
1973 # will overwrite the TTL set in all responses. The maximum allowed value is
1974 # 31,622,400s (1 year), noting that infrequently accessed objects may be
1975 # evicted from the cache before the defined TTL.
1976 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
1977 # origin.
1978 # Cache directives that attempt to set a max-age or s-maxage higher than
1979 # this, or an Expires header more than maxTTL seconds in the future will
1980 # be capped at the value of maxTTL, as if it were the value of an
1981 # s-maxage Cache-Control directive.
1982 # Headers sent to the client will not be modified.
1983 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
1984 # The maximum allowed value is 31,622,400s (1 year), noting that
1985 # infrequently accessed objects may be evicted from the cache before
1986 # the defined TTL.
1987 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
1988 # to apply fine-grained caching for common errors or redirects.
1989 # This can reduce the load on your origin and improve end-user
1990 # experience by reducing response latency.
1991 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
1992 # negative caching applies to responses with the specified response code
1993 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
1994 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
1995 # to all responses with the specified response code, and override any
1996 # caching headers.
1997 # By default, Cloud CDN will apply the following default TTLs to these
1998 # status codes:
1999 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
2000 # HTTP 404 (Not Found), 410 (Gone),
2001 # 451 (Unavailable For Legal Reasons): 120s
2002 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
2003 # These defaults can be overridden in negative_caching_policy.
2004 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
2005 # negative_caching must be enabled to configure negative_caching_policy.
2006 # Omitting the policy and leaving negative_caching enabled will use
2007 # Cloud CDN&#x27;s default cache TTLs.
2008 # Note that when specifying an explicit negative_caching_policy, you
2009 # should take care to specify a cache TTL for all response codes
2010 # that you wish to cache. Cloud CDN will not apply any default
2011 # negative caching when a policy exists.
2012 { # Specify CDN TTLs for response error codes.
2013 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
2014 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
2015 # specified as values, and you cannot specify a status code more than
2016 # once.
2017 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
2018 # corresponding status code.
2019 # The maximum allowed value is 1800s (30 minutes), noting that
2020 # infrequently accessed objects may be evicted from the cache before the
2021 # defined TTL.
2022 },
2023 ],
2024 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
2025 # requests into a small number of requests to the origin.
2026 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
2027 # content with the origin, or when an error is encountered when refreshing
2028 # the cache.
2029 # This setting defines the default &quot;max-stale&quot; duration for any cached
2030 # responses that do not specify a max-stale directive. Stale responses that
2031 # exceed the TTL configured here will not be served. The default limit
2032 # (max-stale) is 86400s (1 day), which will allow stale content to be
2033 # served up to this limit beyond the max-age (or s-maxage) of a cached
2034 # response.
2035 # The maximum allowed value is 604800 (1 week).
2036 # Set this to zero (0) to disable serve-while-stale.
2037 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
2038 # considered fresh. After this time period, the response will be
2039 # revalidated before being served. Defaults to 1hr (3600s). When serving
2040 # responses to signed URL requests, Cloud CDN will internally behave as
2041 # though all responses from this backend had a &quot;Cache-Control:
2042 # public, max-age=[TTL]&quot; header, regardless of any existing
2043 # Cache-Control header. The actual headers served in responses will not be
2044 # altered.
2045 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
2046 &quot;A String&quot;,
2047 ],
2048 },
2049 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
2050 # the client&#x27;s Accept-Encoding header.
2051 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
2052 # text format.
2053 &quot;customResponseHeaders&quot;: [ # Headers that the Application Load Balancer should add to proxied responses.
2054 &quot;A String&quot;,
2055 ],
2056 &quot;description&quot;: &quot;A String&quot;, # An optional textual description of the resource; provided by the client
2057 # when the resource is created.
2058 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
2059 # this backend bucket.
2060 &quot;enableCdn&quot;: True or False, # If true, enable Cloud CDN for this BackendBucket.
2061 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
2062 &quot;kind&quot;: &quot;compute#backendBucket&quot;, # Output only. Type of the resource.
2063 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # The value can only be INTERNAL_MANAGED for cross-region internal layer 7
2064 # load balancer.
2065 #
2066 # If loadBalancingScheme is not specified, the backend bucket can be used by
2067 # classic global external load balancers, or global application external load
2068 # balancers, or both.
2069 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
2070 # The name must be 1-63 characters long, and comply withRFC1035.
2071 # Specifically, the name must be 1-63 characters long and match the regular
2072 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2073 # character must be a lowercase letter, and all following characters must
2074 # be a dash, lowercase letter, or digit, except the last character, which
2075 # cannot be a dash.
2076 &quot;params&quot;: { # Additional Backend Bucket parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
2077 # as part of resource payload.
2078 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
2079 # Tag keys and values have the same definition as resource
2080 # manager tags. The field is allowed for INSERT
2081 # only. The keys/values to set on the resource should be specified in
2082 # either ID { : } or Namespaced format
2083 # { : }.
2084 # For example the following are valid inputs:
2085 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
2086 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
2087 # Note:
2088 # * Invalid combinations of ID &amp; namespaced format is not supported. For
2089 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
2090 &quot;a_key&quot;: &quot;A String&quot;,
2091 },
2092 },
2093 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend bucket
2094 # resides. This field is not applicable to global backend buckets.
2095 # You must specify this field as part of the HTTP request URL. It is
2096 # not settable as a field in the request body.
2097 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2098 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing that backend bucket.
2099 {
2100 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for UrlMaps referencing that
2101 # BackendBucket.
2102 },
2103 ],
2104 },
2105 ],
2106 &quot;kind&quot;: &quot;compute#usableBackendBucketList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#usableBackendBucketList for lists of usable backend
2107 # buckets.
2108 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
2109 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
2110 # the query parameter pageToken in the next list request.
2111 # Subsequent list requests will have their own nextPageToken to
2112 # continue paging through the results.
2113 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
2114 &quot;warning&quot;: { # [Output Only] Informational warning message.
2115 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2116 # Engine returns NO_RESULTS_ON_PAGE if there
2117 # are no results in the response.
2118 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2119 # value format. For example:
2120 #
2121 # &quot;data&quot;: [
2122 # {
2123 # &quot;key&quot;: &quot;scope&quot;,
2124 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2125 # }
2126 {
2127 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2128 # returned. For example, for warnings where there are no results in a list
2129 # request for a particular zone, this key might be scope and
2130 # the key value might be the zone name. Other examples might be a key
2131 # indicating a deprecated resource and a suggested replacement, or a
2132 # warning about invalid network settings (for example, if an instance
2133 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2134 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2135 },
2136 ],
2137 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2138 },
2139 }</pre>
2140 </div>
2141
2142 <div class="method">
2143 <code class="details" id="listUsable_next">listUsable_next()</code>
2144 <pre>Retrieves the next page of results.
2145
2146 Args:
2147 previous_request: The request for the previous page. (required)
2148 previous_response: The response from the request for the previous page. (required)
2149
2150 Returns:
2151 A request object that you can call &#x27;execute()&#x27; on to request the next
2152 page. Returns None if there are no more items in the collection.
2153 </pre>
2154 </div>
2155
2156 <div class="method">
2157 <code class="details" id="list_next">list_next()</code>
2158 <pre>Retrieves the next page of results.
2159
2160 Args:
2161 previous_request: The request for the previous page. (required)
2162 previous_response: The response from the request for the previous page. (required)
2163
2164 Returns:
2165 A request object that you can call &#x27;execute()&#x27; on to request the next
2166 page. Returns None if there are no more items in the collection.
2167 </pre>
2168 </div>
2169
2170 <div class="method">
2171 <code class="details" id="patch">patch(project, region, backendBucket, body=None, requestId=None, x__xgafv=None)</code>
2172 <pre>Updates the specified BackendBucket resource with the data included in the
2173 request. This method supportsPATCH
2174 semantics and uses theJSON merge
2175 patch format and processing rules.
2176
2177 Args:
2178 project: string, Project ID for this request. (required)
2179 region: string, Name of the region scoping this request. (required)
2180 backendBucket: string, Name of the BackendBucket resource to patch. (required)
2181 body: object, The request body.
2182 The object takes the form of:
2183
2184 { # Represents a Cloud Storage Bucket resource.
2185 #
2186 # This Cloud Storage bucket resource is referenced by a URL map of a load
2187 # balancer. For more information, readBackend Buckets.
2188 &quot;bucketName&quot;: &quot;A String&quot;, # Cloud Storage bucket name.
2189 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket.
2190 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
2191 # Pragma or Authorization headers. Up to 5 headers can be specified.
2192 # The cache is bypassed for all cdnPolicy.cacheMode settings.
2193 { # Bypass the cache when the specified request headers are present,
2194 # e.g. Pragma or Authorization headers. Values are case insensitive.
2195 # The presence of such a header overrides the cache_mode setting.
2196 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
2197 # Values are case-insensitive.
2198 },
2199 ],
2200 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for # The CacheKeyPolicy for this CdnPolicy.
2201 # Cloud CDN.
2202 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
2203 &quot;A String&quot;,
2204 ],
2205 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. Default
2206 # parameters are always included. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded
2207 # and not treated as delimiters.
2208 &quot;A String&quot;,
2209 ],
2210 },
2211 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
2212 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
2213 # headers to cache content. Responses without these headers will not be
2214 # cached at Google&#x27;s edge, and will require a full trip to the origin on
2215 # every request, potentially impacting performance and increasing load on
2216 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
2217 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
2218 # Warning: this may result in Cloud CDN caching private,
2219 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
2220 # including common image formats, media (video and audio), and web assets
2221 # (JavaScript and CSS). Requests and responses that are marked as
2222 # uncacheable, as well as dynamic content (including HTML), will not be
2223 # cached.
2224 #
2225 # If no value is provided for cdnPolicy.cacheMode, it defaults
2226 # to CACHE_ALL_STATIC.
2227 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
2228 # used to clamp the max-age (or Expires) value sent to the client. With
2229 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
2230 # response max-age directive, along with a &quot;public&quot; directive. For
2231 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
2232 # from the origin (if specified), or else sets the response max-age
2233 # directive to the lesser of the client_ttl and default_ttl, and also
2234 # ensures a &quot;public&quot; cache-control directive is present.
2235 # If a client TTL is not specified, a default value (1 hour) will be used.
2236 # The maximum allowed value is 31,622,400s (1 year).
2237 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
2238 # responses that do not have an existing valid TTL (max-age or s-maxage).
2239 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
2240 # The value of defaultTTL cannot be set to a value greater than that of
2241 # maxTTL, but can be equal.
2242 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
2243 # will overwrite the TTL set in all responses. The maximum allowed value is
2244 # 31,622,400s (1 year), noting that infrequently accessed objects may be
2245 # evicted from the cache before the defined TTL.
2246 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
2247 # origin.
2248 # Cache directives that attempt to set a max-age or s-maxage higher than
2249 # this, or an Expires header more than maxTTL seconds in the future will
2250 # be capped at the value of maxTTL, as if it were the value of an
2251 # s-maxage Cache-Control directive.
2252 # Headers sent to the client will not be modified.
2253 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
2254 # The maximum allowed value is 31,622,400s (1 year), noting that
2255 # infrequently accessed objects may be evicted from the cache before
2256 # the defined TTL.
2257 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
2258 # to apply fine-grained caching for common errors or redirects.
2259 # This can reduce the load on your origin and improve end-user
2260 # experience by reducing response latency.
2261 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
2262 # negative caching applies to responses with the specified response code
2263 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
2264 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
2265 # to all responses with the specified response code, and override any
2266 # caching headers.
2267 # By default, Cloud CDN will apply the following default TTLs to these
2268 # status codes:
2269 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
2270 # HTTP 404 (Not Found), 410 (Gone),
2271 # 451 (Unavailable For Legal Reasons): 120s
2272 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
2273 # These defaults can be overridden in negative_caching_policy.
2274 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
2275 # negative_caching must be enabled to configure negative_caching_policy.
2276 # Omitting the policy and leaving negative_caching enabled will use
2277 # Cloud CDN&#x27;s default cache TTLs.
2278 # Note that when specifying an explicit negative_caching_policy, you
2279 # should take care to specify a cache TTL for all response codes
2280 # that you wish to cache. Cloud CDN will not apply any default
2281 # negative caching when a policy exists.
2282 { # Specify CDN TTLs for response error codes.
2283 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
2284 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
2285 # specified as values, and you cannot specify a status code more than
2286 # once.
2287 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
2288 # corresponding status code.
2289 # The maximum allowed value is 1800s (30 minutes), noting that
2290 # infrequently accessed objects may be evicted from the cache before the
2291 # defined TTL.
2292 },
2293 ],
2294 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
2295 # requests into a small number of requests to the origin.
2296 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
2297 # content with the origin, or when an error is encountered when refreshing
2298 # the cache.
2299 # This setting defines the default &quot;max-stale&quot; duration for any cached
2300 # responses that do not specify a max-stale directive. Stale responses that
2301 # exceed the TTL configured here will not be served. The default limit
2302 # (max-stale) is 86400s (1 day), which will allow stale content to be
2303 # served up to this limit beyond the max-age (or s-maxage) of a cached
2304 # response.
2305 # The maximum allowed value is 604800 (1 week).
2306 # Set this to zero (0) to disable serve-while-stale.
2307 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
2308 # considered fresh. After this time period, the response will be
2309 # revalidated before being served. Defaults to 1hr (3600s). When serving
2310 # responses to signed URL requests, Cloud CDN will internally behave as
2311 # though all responses from this backend had a &quot;Cache-Control:
2312 # public, max-age=[TTL]&quot; header, regardless of any existing
2313 # Cache-Control header. The actual headers served in responses will not be
2314 # altered.
2315 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
2316 &quot;A String&quot;,
2317 ],
2318 },
2319 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
2320 # the client&#x27;s Accept-Encoding header.
2321 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
2322 # text format.
2323 &quot;customResponseHeaders&quot;: [ # Headers that the Application Load Balancer should add to proxied responses.
2324 &quot;A String&quot;,
2325 ],
2326 &quot;description&quot;: &quot;A String&quot;, # An optional textual description of the resource; provided by the client
2327 # when the resource is created.
2328 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
2329 # this backend bucket.
2330 &quot;enableCdn&quot;: True or False, # If true, enable Cloud CDN for this BackendBucket.
2331 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
2332 &quot;kind&quot;: &quot;compute#backendBucket&quot;, # Output only. Type of the resource.
2333 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # The value can only be INTERNAL_MANAGED for cross-region internal layer 7
2334 # load balancer.
2335 #
2336 # If loadBalancingScheme is not specified, the backend bucket can be used by
2337 # classic global external load balancers, or global application external load
2338 # balancers, or both.
2339 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
2340 # The name must be 1-63 characters long, and comply withRFC1035.
2341 # Specifically, the name must be 1-63 characters long and match the regular
2342 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2343 # character must be a lowercase letter, and all following characters must
2344 # be a dash, lowercase letter, or digit, except the last character, which
2345 # cannot be a dash.
2346 &quot;params&quot;: { # Additional Backend Bucket parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
2347 # as part of resource payload.
2348 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
2349 # Tag keys and values have the same definition as resource
2350 # manager tags. The field is allowed for INSERT
2351 # only. The keys/values to set on the resource should be specified in
2352 # either ID { : } or Namespaced format
2353 # { : }.
2354 # For example the following are valid inputs:
2355 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
2356 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
2357 # Note:
2358 # * Invalid combinations of ID &amp; namespaced format is not supported. For
2359 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
2360 &quot;a_key&quot;: &quot;A String&quot;,
2361 },
2362 },
2363 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend bucket
2364 # resides. This field is not applicable to global backend buckets.
2365 # You must specify this field as part of the HTTP request URL. It is
2366 # not settable as a field in the request body.
2367 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2368 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing that backend bucket.
2369 {
2370 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for UrlMaps referencing that
2371 # BackendBucket.
2372 },
2373 ],
2374 }
2375
2376 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2377 that if you must retry your request, the server will know to ignore the
2378 request if it has already been completed.
2379
2380 For example, consider a situation where you make an initial request and
2381 the request times out. If you make the request again with the same
2382 request ID, the server can check if original operation with the same
2383 request ID was received, and if so, will ignore the second request. This
2384 prevents clients from accidentally creating duplicate commitments.
2385
2386 The request ID must be
2387 a valid UUID with the exception that zero UUID is not supported
2388 (00000000-0000-0000-0000-000000000000).
2389 end_interface: MixerMutationRequestBuilder
2390 x__xgafv: string, V1 error format.
2391 Allowed values
2392 1 - v1 error format
2393 2 - v2 error format
2394
2395 Returns:
2396 An object of the form:
2397
2398 { # Represents an Operation resource.
2399 #
2400 # Google Compute Engine has three Operation resources:
2401 #
2402 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
2403 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
2404 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
2405 #
2406 # You can use an operation resource to manage asynchronous API requests.
2407 # For more information, readHandling
2408 # API responses.
2409 #
2410 # Operations can be global, regional or zonal.
2411 #
2412 # - For global operations, use the `globalOperations`
2413 # resource.
2414 # - For regional operations, use the
2415 # `regionOperations` resource.
2416 # - For zonal operations, use
2417 # the `zoneOperations` resource.
2418 #
2419 #
2420 #
2421 # For more information, read
2422 # Global, Regional, and Zonal Resources.
2423 #
2424 # Note that completed Operation resources have a limited
2425 # retention period.
2426 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2427 # Not present otherwise.
2428 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2429 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2430 # set when the operation is created.
2431 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2432 # text format.
2433 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2434 # this field will be populated.
2435 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2436 # operation.
2437 {
2438 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2439 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2440 # details. There is a set of defined message types to use for providing
2441 # details.The syntax depends on the error code. For example,
2442 # QuotaExceededInfo will have details when the error code is
2443 # QUOTA_EXCEEDED.
2444 {
2445 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2446 #
2447 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2448 # is not enabled:
2449 #
2450 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2451 # &quot;domain&quot;: &quot;googleapis.com&quot;
2452 # &quot;metadata&quot;: {
2453 # &quot;resource&quot;: &quot;projects/123&quot;,
2454 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2455 # }
2456 # }
2457 #
2458 # This response indicates that the pubsub.googleapis.com API is not enabled.
2459 #
2460 # Example of an error that is returned when attempting to create a Spanner
2461 # instance in a region that is out of stock:
2462 #
2463 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2464 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2465 # &quot;metadata&quot;: {
2466 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2467 # }
2468 # }
2469 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2470 # is typically the registered service name of the tool or product that
2471 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2472 # generated by some common infrastructure, the error domain must be a
2473 # globally unique value that identifies the infrastructure. For Google API
2474 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2475 &quot;metadatas&quot;: { # Additional structured details about this error.
2476 #
2477 # Keys must match a regular expression of `a-z+` but should
2478 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2479 # length. When identifying the current value of an exceeded limit, the units
2480 # should be contained in the key, not the value. For example, rather than
2481 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2482 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2483 # instances that can be created in a single (batch) request.
2484 &quot;a_key&quot;: &quot;A String&quot;,
2485 },
2486 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2487 # proximate cause of the error. Error reasons are unique within a particular
2488 # domain of errors. This should be at most 63 characters and match a
2489 # regular expression of `A-Z+[A-Z0-9]`, which represents
2490 # UPPER_SNAKE_CASE.
2491 },
2492 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2493 #
2494 # For example, if a quota check failed with an error indicating the calling
2495 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2496 # directly to the right place in the developer console to flip the bit.
2497 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2498 { # Describes a URL link.
2499 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2500 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2501 },
2502 ],
2503 },
2504 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2505 # which can be attached to an RPC error.
2506 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2507 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2508 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2509 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2510 },
2511 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2512 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2513 &quot;a_key&quot;: &quot;A String&quot;,
2514 },
2515 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2516 # type or metric.
2517 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2518 # or metric.
2519 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2520 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2521 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2522 },
2523 },
2524 ],
2525 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2526 # This property is optional.
2527 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2528 },
2529 ],
2530 },
2531 &quot;getVersionOperationMetadata&quot;: {
2532 &quot;inlineSbomInfo&quot;: {
2533 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2534 # appropriate identifiers.
2535 &quot;a_key&quot;: &quot;A String&quot;,
2536 },
2537 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2538 # identifiers.
2539 &quot;a_key&quot;: &quot;A String&quot;,
2540 },
2541 },
2542 },
2543 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2544 # message that was returned, such as `NOT FOUND`.
2545 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2546 # status code that was returned. For example, a `404` means the
2547 # resource was not found.
2548 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2549 # defined by the server.
2550 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2551 # This value is inRFC3339
2552 # text format.
2553 &quot;instancesBulkInsertOperationMetadata&quot;: {
2554 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2555 # Example key: zones/us-central1-a
2556 &quot;a_key&quot;: {
2557 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2558 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2559 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2560 # error.
2561 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2562 # if the flow is rolling forward or rolling back.
2563 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2564 },
2565 },
2566 },
2567 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2568 # Operation resources.
2569 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2570 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2571 # group of operations results from a `bulkInsert` API request.
2572 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2573 # `update`, or `delete`, and so on.
2574 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2575 # There is no requirement that this be linear or support any granularity of
2576 # operations. This should not be used to guess when the operation will be
2577 # complete. This number should monotonically increase as the operation
2578 # progresses.
2579 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2580 # applicable when performing regional operations.
2581 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2582 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2583 # this field will contain information on all underlying zonal actions and
2584 # their state.
2585 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2586 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2587 # Example key: zones/us-central1-a
2588 &quot;a_key&quot;: {
2589 &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
2590 # populated.
2591 # different programming environments, including REST APIs and RPC APIs. It is
2592 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2593 # three pieces of data: error code, error message, and error details.
2594 #
2595 # You can find out more about this error model and how to work with it in the
2596 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2597 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2598 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2599 # message types for APIs to use.
2600 {
2601 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2602 },
2603 ],
2604 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2605 # user-facing error message should be localized and sent in the
2606 # google.rpc.Status.details field, or localized by the client.
2607 },
2608 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2609 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2610 },
2611 },
2612 },
2613 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2614 # This value is inRFC3339
2615 # text format.
2616 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2617 # following:
2618 # `PENDING`, `RUNNING`, or `DONE`.
2619 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2620 # operation.
2621 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2622 # of the target resource.
2623 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2624 # operations related to creating a snapshot, this points to the disk
2625 # that the snapshot was created from.
2626 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2627 # `[email protected]` or
2628 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2629 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2630 # operation, this field will be populated.
2631 {
2632 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2633 # Engine returns NO_RESULTS_ON_PAGE if there
2634 # are no results in the response.
2635 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2636 # value format. For example:
2637 #
2638 # &quot;data&quot;: [
2639 # {
2640 # &quot;key&quot;: &quot;scope&quot;,
2641 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2642 # }
2643 {
2644 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2645 # returned. For example, for warnings where there are no results in a list
2646 # request for a particular zone, this key might be scope and
2647 # the key value might be the zone name. Other examples might be a key
2648 # indicating a deprecated resource and a suggested replacement, or a
2649 # warning about invalid network settings (for example, if an instance
2650 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2651 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2652 },
2653 ],
2654 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2655 },
2656 ],
2657 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2658 # applicable when performing per-zone operations.
2659 }</pre>
2660 </div>
2661
2662 <div class="method">
2663 <code class="details" id="setIamPolicy">setIamPolicy(project, region, resource, body=None, x__xgafv=None)</code>
2664 <pre>Sets the access control policy on the specified resource.
2665 Replaces any existing policy.
2666
2667 Args:
2668 project: string, Project ID for this request. (required)
2669 region: string, The name of the region for this request. (required)
2670 resource: string, Name or id of the resource for this request. (required)
2671 body: object, The request body.
2672 The object takes the form of:
2673
2674 {
2675 &quot;bindings&quot;: [ # Flatten Policy to create a backwacd compatible wire-format.
2676 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
2677 { # Associates `members`, or principals, with a `role`.
2678 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
2679 #
2680 # If the condition evaluates to `true`, then this binding applies to the
2681 # current request.
2682 #
2683 # If the condition evaluates to `false`, then this binding does not apply to
2684 # the current request. However, a different role binding might grant the same
2685 # role to one or more of the principals in this binding.
2686 #
2687 # To learn which resources support conditions in their IAM policies, see the
2688 # [IAM
2689 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2690 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
2691 # are documented at https://github.com/google/cel-spec.
2692 #
2693 # Example (Comparison):
2694 #
2695 # title: &quot;Summary size limit&quot;
2696 # description: &quot;Determines if a summary is less than 100 chars&quot;
2697 # expression: &quot;document.summary.size() &lt; 100&quot;
2698 #
2699 # Example (Equality):
2700 #
2701 # title: &quot;Requestor is owner&quot;
2702 # description: &quot;Determines if requestor is the document owner&quot;
2703 # expression: &quot;document.owner == request.auth.claims.email&quot;
2704 #
2705 # Example (Logic):
2706 #
2707 # title: &quot;Public documents&quot;
2708 # description: &quot;Determine whether the document should be publicly visible&quot;
2709 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
2710 #
2711 # Example (Data Manipulation):
2712 #
2713 # title: &quot;Notification string&quot;
2714 # description: &quot;Create a notification string with a timestamp.&quot;
2715 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
2716 #
2717 # The exact variables and functions that may be referenced within an expression
2718 # are determined by the service that evaluates it. See the service
2719 # documentation for additional information.
2720 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
2721 # describes the expression, e.g. when hovered over it in a UI.
2722 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
2723 # syntax.
2724 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
2725 # reporting, e.g. a file name and a position in the file.
2726 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
2727 # its purpose. This can be used e.g. in UIs which allow to enter the
2728 # expression.
2729 },
2730 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
2731 # `members` can have the following values:
2732 #
2733 # * `allUsers`: A special identifier that represents anyone who is
2734 # on the internet; with or without a Google account.
2735 #
2736 # * `allAuthenticatedUsers`: A special identifier that represents anyone
2737 # who is authenticated with a Google account or a service account.
2738 # Does not include identities that come from external identity providers
2739 # (IdPs) through identity federation.
2740 #
2741 # * `user:{emailid}`: An email address that represents a specific Google
2742 # account. For example, `[email protected]` .
2743 #
2744 #
2745 # * `serviceAccount:{emailid}`: An email address that represents a Google
2746 # service account. For example,
2747 # `[email protected]`.
2748 #
2749 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
2750 # identifier for a
2751 # [Kubernetes service
2752 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
2753 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
2754 #
2755 # * `group:{emailid}`: An email address that represents a Google group.
2756 # For example, `[email protected]`.
2757 #
2758 #
2759 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
2760 # users of that domain. For example, `google.com` or `example.com`.
2761 #
2762 #
2763 #
2764 #
2765 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2766 # A single identity in a workforce identity pool.
2767 #
2768 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
2769 # All workforce identities in a group.
2770 #
2771 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2772 # All workforce identities with a specific attribute value.
2773 #
2774 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
2775 # All identities in a workforce identity pool.
2776 #
2777 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
2778 # A single identity in a workload identity pool.
2779 #
2780 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
2781 # A workload identity pool group.
2782 #
2783 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2784 # All identities in a workload identity pool with a certain attribute.
2785 #
2786 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
2787 # All identities in a workload identity pool.
2788 #
2789 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
2790 # identifier) representing a user that has been recently deleted. For
2791 # example, `[email protected]?uid=123456789012345678901`. If the user is
2792 # recovered, this value reverts to `user:{emailid}` and the recovered user
2793 # retains the role in the binding.
2794 #
2795 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
2796 # unique identifier) representing a service account that has been recently
2797 # deleted. For example,
2798 # `[email protected]?uid=123456789012345678901`.
2799 # If the service account is undeleted, this value reverts to
2800 # `serviceAccount:{emailid}` and the undeleted service account retains the
2801 # role in the binding.
2802 #
2803 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
2804 # identifier) representing a Google group that has been recently
2805 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
2806 # the group is recovered, this value reverts to `group:{emailid}` and the
2807 # recovered group retains the role in the binding.
2808 #
2809 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2810 # Deleted single identity in a workforce identity pool. For example,
2811 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
2812 &quot;A String&quot;,
2813 ],
2814 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
2815 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
2816 #
2817 # For an overview of the IAM roles and permissions, see the
2818 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
2819 # a list of the available pre-defined roles, see
2820 # [here](https://cloud.google.com/iam/docs/understanding-roles).
2821 },
2822 ],
2823 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
2824 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
2825 &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
2826 # the policy is limited to a few 10s of KB. An empty policy is in general a
2827 # valid policy but certain services (like Projects) might reject them.
2828 # controls for Google Cloud resources.
2829 #
2830 #
2831 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
2832 # `members`, or principals, to a single `role`. Principals can be user
2833 # accounts, service accounts, Google groups, and domains (such as G Suite). A
2834 # `role` is a named list of permissions; each `role` can be an IAM predefined
2835 # role or a user-created custom role.
2836 #
2837 # For some types of Google Cloud resources, a `binding` can also specify a
2838 # `condition`, which is a logical expression that allows access to a resource
2839 # only if the expression evaluates to `true`. A condition can add constraints
2840 # based on attributes of the request, the resource, or both. To learn which
2841 # resources support conditions in their IAM policies, see the
2842 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2843 #
2844 # **JSON example:**
2845 #
2846 # ```
2847 # {
2848 # &quot;bindings&quot;: [
2849 # {
2850 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
2851 # &quot;members&quot;: [
2852 # &quot;user:[email protected]&quot;,
2853 # &quot;group:[email protected]&quot;,
2854 # &quot;domain:google.com&quot;,
2855 # &quot;serviceAccount:[email protected]&quot;
2856 # ]
2857 # },
2858 # {
2859 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
2860 # &quot;members&quot;: [
2861 # &quot;user:[email protected]&quot;
2862 # ],
2863 # &quot;condition&quot;: {
2864 # &quot;title&quot;: &quot;expirable access&quot;,
2865 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
2866 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
2867 # }
2868 # }
2869 # ],
2870 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
2871 # &quot;version&quot;: 3
2872 # }
2873 # ```
2874 #
2875 # **YAML example:**
2876 #
2877 # ```
2878 # bindings:
2879 # - members:
2880 # - user:[email protected]
2881 # - group:[email protected]
2882 # - domain:google.com
2883 # - serviceAccount:[email protected]
2884 # role: roles/resourcemanager.organizationAdmin
2885 # - members:
2886 # - user:[email protected]
2887 # role: roles/resourcemanager.organizationViewer
2888 # condition:
2889 # title: expirable access
2890 # description: Does not grant access after Sep 2020
2891 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
2892 # etag: BwWWja0YfJA=
2893 # version: 3
2894 # ```
2895 #
2896 # For a description of IAM and its features, see the
2897 # [IAM documentation](https://cloud.google.com/iam/docs/).
2898 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
2899 { # Specifies the audit configuration for a service.
2900 # The configuration determines which permission types are logged, and what
2901 # identities, if any, are exempted from logging.
2902 # An AuditConfig must have one or more AuditLogConfigs.
2903 #
2904 # If there are AuditConfigs for both `allServices` and a specific service,
2905 # the union of the two AuditConfigs is used for that service: the log_types
2906 # specified in each AuditConfig are enabled, and the exempted_members in each
2907 # AuditLogConfig are exempted.
2908 #
2909 # Example Policy with multiple AuditConfigs:
2910 #
2911 # {
2912 # &quot;audit_configs&quot;: [
2913 # {
2914 # &quot;service&quot;: &quot;allServices&quot;,
2915 # &quot;audit_log_configs&quot;: [
2916 # {
2917 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
2918 # &quot;exempted_members&quot;: [
2919 # &quot;user:[email protected]&quot;
2920 # ]
2921 # },
2922 # {
2923 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
2924 # },
2925 # {
2926 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
2927 # }
2928 # ]
2929 # },
2930 # {
2931 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
2932 # &quot;audit_log_configs&quot;: [
2933 # {
2934 # &quot;log_type&quot;: &quot;DATA_READ&quot;
2935 # },
2936 # {
2937 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
2938 # &quot;exempted_members&quot;: [
2939 # &quot;user:[email protected]&quot;
2940 # ]
2941 # }
2942 # ]
2943 # }
2944 # ]
2945 # }
2946 #
2947 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
2948 # logging. It also exempts `[email protected]` from DATA_READ logging, and
2949 # `[email protected]` from DATA_WRITE logging.
2950 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
2951 { # Provides the configuration for logging a type of permissions.
2952 # Example:
2953 #
2954 # {
2955 # &quot;audit_log_configs&quot;: [
2956 # {
2957 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
2958 # &quot;exempted_members&quot;: [
2959 # &quot;user:[email protected]&quot;
2960 # ]
2961 # },
2962 # {
2963 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
2964 # }
2965 # ]
2966 # }
2967 #
2968 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
2969 # [email protected] from DATA_READ logging.
2970 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
2971 # permission.
2972 # Follows the same format of Binding.members.
2973 &quot;A String&quot;,
2974 ],
2975 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
2976 },
2977 ],
2978 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
2979 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
2980 # `allServices` is a special value that covers all services.
2981 },
2982 ],
2983 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
2984 # may specify a `condition` that determines how and when the `bindings` are
2985 # applied. Each of the `bindings` must contain at least one principal.
2986 #
2987 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
2988 # of these principals can be Google groups. Each occurrence of a principal
2989 # counts towards these limits. For example, if the `bindings` grant 50
2990 # different roles to `user:[email protected]`, and not to any other
2991 # principal, then you can add another 1,450 principals to the `bindings` in
2992 # the `Policy`.
2993 { # Associates `members`, or principals, with a `role`.
2994 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
2995 #
2996 # If the condition evaluates to `true`, then this binding applies to the
2997 # current request.
2998 #
2999 # If the condition evaluates to `false`, then this binding does not apply to
3000 # the current request. However, a different role binding might grant the same
3001 # role to one or more of the principals in this binding.
3002 #
3003 # To learn which resources support conditions in their IAM policies, see the
3004 # [IAM
3005 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3006 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
3007 # are documented at https://github.com/google/cel-spec.
3008 #
3009 # Example (Comparison):
3010 #
3011 # title: &quot;Summary size limit&quot;
3012 # description: &quot;Determines if a summary is less than 100 chars&quot;
3013 # expression: &quot;document.summary.size() &lt; 100&quot;
3014 #
3015 # Example (Equality):
3016 #
3017 # title: &quot;Requestor is owner&quot;
3018 # description: &quot;Determines if requestor is the document owner&quot;
3019 # expression: &quot;document.owner == request.auth.claims.email&quot;
3020 #
3021 # Example (Logic):
3022 #
3023 # title: &quot;Public documents&quot;
3024 # description: &quot;Determine whether the document should be publicly visible&quot;
3025 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
3026 #
3027 # Example (Data Manipulation):
3028 #
3029 # title: &quot;Notification string&quot;
3030 # description: &quot;Create a notification string with a timestamp.&quot;
3031 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
3032 #
3033 # The exact variables and functions that may be referenced within an expression
3034 # are determined by the service that evaluates it. See the service
3035 # documentation for additional information.
3036 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
3037 # describes the expression, e.g. when hovered over it in a UI.
3038 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
3039 # syntax.
3040 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
3041 # reporting, e.g. a file name and a position in the file.
3042 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
3043 # its purpose. This can be used e.g. in UIs which allow to enter the
3044 # expression.
3045 },
3046 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
3047 # `members` can have the following values:
3048 #
3049 # * `allUsers`: A special identifier that represents anyone who is
3050 # on the internet; with or without a Google account.
3051 #
3052 # * `allAuthenticatedUsers`: A special identifier that represents anyone
3053 # who is authenticated with a Google account or a service account.
3054 # Does not include identities that come from external identity providers
3055 # (IdPs) through identity federation.
3056 #
3057 # * `user:{emailid}`: An email address that represents a specific Google
3058 # account. For example, `[email protected]` .
3059 #
3060 #
3061 # * `serviceAccount:{emailid}`: An email address that represents a Google
3062 # service account. For example,
3063 # `[email protected]`.
3064 #
3065 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
3066 # identifier for a
3067 # [Kubernetes service
3068 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
3069 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
3070 #
3071 # * `group:{emailid}`: An email address that represents a Google group.
3072 # For example, `[email protected]`.
3073 #
3074 #
3075 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
3076 # users of that domain. For example, `google.com` or `example.com`.
3077 #
3078 #
3079 #
3080 #
3081 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3082 # A single identity in a workforce identity pool.
3083 #
3084 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
3085 # All workforce identities in a group.
3086 #
3087 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3088 # All workforce identities with a specific attribute value.
3089 #
3090 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
3091 # All identities in a workforce identity pool.
3092 #
3093 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
3094 # A single identity in a workload identity pool.
3095 #
3096 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
3097 # A workload identity pool group.
3098 #
3099 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3100 # All identities in a workload identity pool with a certain attribute.
3101 #
3102 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
3103 # All identities in a workload identity pool.
3104 #
3105 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
3106 # identifier) representing a user that has been recently deleted. For
3107 # example, `[email protected]?uid=123456789012345678901`. If the user is
3108 # recovered, this value reverts to `user:{emailid}` and the recovered user
3109 # retains the role in the binding.
3110 #
3111 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
3112 # unique identifier) representing a service account that has been recently
3113 # deleted. For example,
3114 # `[email protected]?uid=123456789012345678901`.
3115 # If the service account is undeleted, this value reverts to
3116 # `serviceAccount:{emailid}` and the undeleted service account retains the
3117 # role in the binding.
3118 #
3119 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
3120 # identifier) representing a Google group that has been recently
3121 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
3122 # the group is recovered, this value reverts to `group:{emailid}` and the
3123 # recovered group retains the role in the binding.
3124 #
3125 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3126 # Deleted single identity in a workforce identity pool. For example,
3127 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
3128 &quot;A String&quot;,
3129 ],
3130 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
3131 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
3132 #
3133 # For an overview of the IAM roles and permissions, see the
3134 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
3135 # a list of the available pre-defined roles, see
3136 # [here](https://cloud.google.com/iam/docs/understanding-roles).
3137 },
3138 ],
3139 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
3140 # prevent simultaneous updates of a policy from overwriting each other.
3141 # It is strongly suggested that systems make use of the `etag` in the
3142 # read-modify-write cycle to perform policy updates in order to avoid race
3143 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
3144 # systems are expected to put that etag in the request to `setIamPolicy` to
3145 # ensure that their change will be applied to the same version of the policy.
3146 #
3147 # **Important:** If you use IAM Conditions, you must include the `etag` field
3148 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3149 # you to overwrite a version `3` policy with a version `1` policy, and all of
3150 # the conditions in the version `3` policy are lost.
3151 &quot;version&quot;: 42, # Specifies the format of the policy.
3152 #
3153 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
3154 # are rejected.
3155 #
3156 # Any operation that affects conditional role bindings must specify version
3157 # `3`. This requirement applies to the following operations:
3158 #
3159 # * Getting a policy that includes a conditional role binding
3160 # * Adding a conditional role binding to a policy
3161 # * Changing a conditional role binding in a policy
3162 # * Removing any role binding, with or without a condition, from a policy
3163 # that includes conditions
3164 #
3165 # **Important:** If you use IAM Conditions, you must include the `etag` field
3166 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3167 # you to overwrite a version `3` policy with a version `1` policy, and all of
3168 # the conditions in the version `3` policy are lost.
3169 #
3170 # If a policy does not include any conditions, operations on that policy may
3171 # specify any valid version or leave the field unset.
3172 #
3173 # To learn which resources support conditions in their IAM policies, see the
3174 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3175 },
3176 }
3177
3178 x__xgafv: string, V1 error format.
3179 Allowed values
3180 1 - v1 error format
3181 2 - v2 error format
3182
3183 Returns:
3184 An object of the form:
3185
3186 { # An Identity and Access Management (IAM) policy, which specifies access
3187 # controls for Google Cloud resources.
3188 #
3189 #
3190 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
3191 # `members`, or principals, to a single `role`. Principals can be user
3192 # accounts, service accounts, Google groups, and domains (such as G Suite). A
3193 # `role` is a named list of permissions; each `role` can be an IAM predefined
3194 # role or a user-created custom role.
3195 #
3196 # For some types of Google Cloud resources, a `binding` can also specify a
3197 # `condition`, which is a logical expression that allows access to a resource
3198 # only if the expression evaluates to `true`. A condition can add constraints
3199 # based on attributes of the request, the resource, or both. To learn which
3200 # resources support conditions in their IAM policies, see the
3201 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3202 #
3203 # **JSON example:**
3204 #
3205 # ```
3206 # {
3207 # &quot;bindings&quot;: [
3208 # {
3209 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
3210 # &quot;members&quot;: [
3211 # &quot;user:[email protected]&quot;,
3212 # &quot;group:[email protected]&quot;,
3213 # &quot;domain:google.com&quot;,
3214 # &quot;serviceAccount:[email protected]&quot;
3215 # ]
3216 # },
3217 # {
3218 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
3219 # &quot;members&quot;: [
3220 # &quot;user:[email protected]&quot;
3221 # ],
3222 # &quot;condition&quot;: {
3223 # &quot;title&quot;: &quot;expirable access&quot;,
3224 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
3225 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
3226 # }
3227 # }
3228 # ],
3229 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
3230 # &quot;version&quot;: 3
3231 # }
3232 # ```
3233 #
3234 # **YAML example:**
3235 #
3236 # ```
3237 # bindings:
3238 # - members:
3239 # - user:[email protected]
3240 # - group:[email protected]
3241 # - domain:google.com
3242 # - serviceAccount:[email protected]
3243 # role: roles/resourcemanager.organizationAdmin
3244 # - members:
3245 # - user:[email protected]
3246 # role: roles/resourcemanager.organizationViewer
3247 # condition:
3248 # title: expirable access
3249 # description: Does not grant access after Sep 2020
3250 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
3251 # etag: BwWWja0YfJA=
3252 # version: 3
3253 # ```
3254 #
3255 # For a description of IAM and its features, see the
3256 # [IAM documentation](https://cloud.google.com/iam/docs/).
3257 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
3258 { # Specifies the audit configuration for a service.
3259 # The configuration determines which permission types are logged, and what
3260 # identities, if any, are exempted from logging.
3261 # An AuditConfig must have one or more AuditLogConfigs.
3262 #
3263 # If there are AuditConfigs for both `allServices` and a specific service,
3264 # the union of the two AuditConfigs is used for that service: the log_types
3265 # specified in each AuditConfig are enabled, and the exempted_members in each
3266 # AuditLogConfig are exempted.
3267 #
3268 # Example Policy with multiple AuditConfigs:
3269 #
3270 # {
3271 # &quot;audit_configs&quot;: [
3272 # {
3273 # &quot;service&quot;: &quot;allServices&quot;,
3274 # &quot;audit_log_configs&quot;: [
3275 # {
3276 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3277 # &quot;exempted_members&quot;: [
3278 # &quot;user:[email protected]&quot;
3279 # ]
3280 # },
3281 # {
3282 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3283 # },
3284 # {
3285 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
3286 # }
3287 # ]
3288 # },
3289 # {
3290 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
3291 # &quot;audit_log_configs&quot;: [
3292 # {
3293 # &quot;log_type&quot;: &quot;DATA_READ&quot;
3294 # },
3295 # {
3296 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
3297 # &quot;exempted_members&quot;: [
3298 # &quot;user:[email protected]&quot;
3299 # ]
3300 # }
3301 # ]
3302 # }
3303 # ]
3304 # }
3305 #
3306 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
3307 # logging. It also exempts `[email protected]` from DATA_READ logging, and
3308 # `[email protected]` from DATA_WRITE logging.
3309 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
3310 { # Provides the configuration for logging a type of permissions.
3311 # Example:
3312 #
3313 # {
3314 # &quot;audit_log_configs&quot;: [
3315 # {
3316 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3317 # &quot;exempted_members&quot;: [
3318 # &quot;user:[email protected]&quot;
3319 # ]
3320 # },
3321 # {
3322 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3323 # }
3324 # ]
3325 # }
3326 #
3327 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
3328 # [email protected] from DATA_READ logging.
3329 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
3330 # permission.
3331 # Follows the same format of Binding.members.
3332 &quot;A String&quot;,
3333 ],
3334 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
3335 },
3336 ],
3337 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
3338 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
3339 # `allServices` is a special value that covers all services.
3340 },
3341 ],
3342 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
3343 # may specify a `condition` that determines how and when the `bindings` are
3344 # applied. Each of the `bindings` must contain at least one principal.
3345 #
3346 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
3347 # of these principals can be Google groups. Each occurrence of a principal
3348 # counts towards these limits. For example, if the `bindings` grant 50
3349 # different roles to `user:[email protected]`, and not to any other
3350 # principal, then you can add another 1,450 principals to the `bindings` in
3351 # the `Policy`.
3352 { # Associates `members`, or principals, with a `role`.
3353 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
3354 #
3355 # If the condition evaluates to `true`, then this binding applies to the
3356 # current request.
3357 #
3358 # If the condition evaluates to `false`, then this binding does not apply to
3359 # the current request. However, a different role binding might grant the same
3360 # role to one or more of the principals in this binding.
3361 #
3362 # To learn which resources support conditions in their IAM policies, see the
3363 # [IAM
3364 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3365 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
3366 # are documented at https://github.com/google/cel-spec.
3367 #
3368 # Example (Comparison):
3369 #
3370 # title: &quot;Summary size limit&quot;
3371 # description: &quot;Determines if a summary is less than 100 chars&quot;
3372 # expression: &quot;document.summary.size() &lt; 100&quot;
3373 #
3374 # Example (Equality):
3375 #
3376 # title: &quot;Requestor is owner&quot;
3377 # description: &quot;Determines if requestor is the document owner&quot;
3378 # expression: &quot;document.owner == request.auth.claims.email&quot;
3379 #
3380 # Example (Logic):
3381 #
3382 # title: &quot;Public documents&quot;
3383 # description: &quot;Determine whether the document should be publicly visible&quot;
3384 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
3385 #
3386 # Example (Data Manipulation):
3387 #
3388 # title: &quot;Notification string&quot;
3389 # description: &quot;Create a notification string with a timestamp.&quot;
3390 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
3391 #
3392 # The exact variables and functions that may be referenced within an expression
3393 # are determined by the service that evaluates it. See the service
3394 # documentation for additional information.
3395 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
3396 # describes the expression, e.g. when hovered over it in a UI.
3397 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
3398 # syntax.
3399 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
3400 # reporting, e.g. a file name and a position in the file.
3401 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
3402 # its purpose. This can be used e.g. in UIs which allow to enter the
3403 # expression.
3404 },
3405 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
3406 # `members` can have the following values:
3407 #
3408 # * `allUsers`: A special identifier that represents anyone who is
3409 # on the internet; with or without a Google account.
3410 #
3411 # * `allAuthenticatedUsers`: A special identifier that represents anyone
3412 # who is authenticated with a Google account or a service account.
3413 # Does not include identities that come from external identity providers
3414 # (IdPs) through identity federation.
3415 #
3416 # * `user:{emailid}`: An email address that represents a specific Google
3417 # account. For example, `[email protected]` .
3418 #
3419 #
3420 # * `serviceAccount:{emailid}`: An email address that represents a Google
3421 # service account. For example,
3422 # `[email protected]`.
3423 #
3424 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
3425 # identifier for a
3426 # [Kubernetes service
3427 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
3428 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
3429 #
3430 # * `group:{emailid}`: An email address that represents a Google group.
3431 # For example, `[email protected]`.
3432 #
3433 #
3434 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
3435 # users of that domain. For example, `google.com` or `example.com`.
3436 #
3437 #
3438 #
3439 #
3440 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3441 # A single identity in a workforce identity pool.
3442 #
3443 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
3444 # All workforce identities in a group.
3445 #
3446 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3447 # All workforce identities with a specific attribute value.
3448 #
3449 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
3450 # All identities in a workforce identity pool.
3451 #
3452 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
3453 # A single identity in a workload identity pool.
3454 #
3455 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
3456 # A workload identity pool group.
3457 #
3458 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3459 # All identities in a workload identity pool with a certain attribute.
3460 #
3461 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
3462 # All identities in a workload identity pool.
3463 #
3464 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
3465 # identifier) representing a user that has been recently deleted. For
3466 # example, `[email protected]?uid=123456789012345678901`. If the user is
3467 # recovered, this value reverts to `user:{emailid}` and the recovered user
3468 # retains the role in the binding.
3469 #
3470 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
3471 # unique identifier) representing a service account that has been recently
3472 # deleted. For example,
3473 # `[email protected]?uid=123456789012345678901`.
3474 # If the service account is undeleted, this value reverts to
3475 # `serviceAccount:{emailid}` and the undeleted service account retains the
3476 # role in the binding.
3477 #
3478 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
3479 # identifier) representing a Google group that has been recently
3480 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
3481 # the group is recovered, this value reverts to `group:{emailid}` and the
3482 # recovered group retains the role in the binding.
3483 #
3484 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3485 # Deleted single identity in a workforce identity pool. For example,
3486 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
3487 &quot;A String&quot;,
3488 ],
3489 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
3490 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
3491 #
3492 # For an overview of the IAM roles and permissions, see the
3493 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
3494 # a list of the available pre-defined roles, see
3495 # [here](https://cloud.google.com/iam/docs/understanding-roles).
3496 },
3497 ],
3498 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
3499 # prevent simultaneous updates of a policy from overwriting each other.
3500 # It is strongly suggested that systems make use of the `etag` in the
3501 # read-modify-write cycle to perform policy updates in order to avoid race
3502 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
3503 # systems are expected to put that etag in the request to `setIamPolicy` to
3504 # ensure that their change will be applied to the same version of the policy.
3505 #
3506 # **Important:** If you use IAM Conditions, you must include the `etag` field
3507 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3508 # you to overwrite a version `3` policy with a version `1` policy, and all of
3509 # the conditions in the version `3` policy are lost.
3510 &quot;version&quot;: 42, # Specifies the format of the policy.
3511 #
3512 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
3513 # are rejected.
3514 #
3515 # Any operation that affects conditional role bindings must specify version
3516 # `3`. This requirement applies to the following operations:
3517 #
3518 # * Getting a policy that includes a conditional role binding
3519 # * Adding a conditional role binding to a policy
3520 # * Changing a conditional role binding in a policy
3521 # * Removing any role binding, with or without a condition, from a policy
3522 # that includes conditions
3523 #
3524 # **Important:** If you use IAM Conditions, you must include the `etag` field
3525 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3526 # you to overwrite a version `3` policy with a version `1` policy, and all of
3527 # the conditions in the version `3` policy are lost.
3528 #
3529 # If a policy does not include any conditions, operations on that policy may
3530 # specify any valid version or leave the field unset.
3531 #
3532 # To learn which resources support conditions in their IAM policies, see the
3533 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3534 }</pre>
3535 </div>
3536
3537 <div class="method">
3538 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code>
3539 <pre>Returns permissions that a caller has on the specified resource.
3540
3541 Args:
3542 project: string, Project ID for this request. (required)
3543 region: string, The name of the region for this request. (required)
3544 resource: string, Name or id of the resource for this request. (required)
3545 body: object, The request body.
3546 The object takes the form of:
3547
3548 {
3549 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
3550 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
3551 &quot;A String&quot;,
3552 ],
3553 }
3554
3555 x__xgafv: string, V1 error format.
3556 Allowed values
3557 1 - v1 error format
3558 2 - v2 error format
3559
3560 Returns:
3561 An object of the form:
3562
3563 {
3564 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
3565 # allowed.
3566 &quot;A String&quot;,
3567 ],
3568 }</pre>
3569 </div>
3570
3571 </body></html>