Debian Codegraph @

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