Debian Codegraph @

docs/dyn/compute_alpha.backendBuckets.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.backendBuckets.html">backendBuckets</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#addSignedUrlKey">addSignedUrlKey(project, backendBucket, body=None, requestId=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Adds a key for validating requests with signed URLs for this backend</p>
80 <p class="toc_element">
81 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Retrieves the list of all BackendBucket resources, regional and global,</p>
83 <p class="toc_element">
84 <code><a href="#aggregatedList_next">aggregatedList_next()</a></code></p>
85 <p class="firstline">Retrieves the next page of results.</p>
86 <p class="toc_element">
87 <code><a href="#close">close()</a></code></p>
88 <p class="firstline">Close httplib2 connections.</p>
89 <p class="toc_element">
90 <code><a href="#delete">delete(project, backendBucket, requestId=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Deletes the specified BackendBucket resource.</p>
92 <p class="toc_element">
93 <code><a href="#deleteSignedUrlKey">deleteSignedUrlKey(project, backendBucket, keyName, requestId=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Deletes a key for validating requests with signed URLs for this backend</p>
95 <p class="toc_element">
96 <code><a href="#get">get(project, backendBucket, x__xgafv=None)</a></code></p>
97 <p class="firstline">Returns the specified BackendBucket resource.</p>
98 <p class="toc_element">
99 <code><a href="#getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Gets the access control policy for a resource. May be empty if no such</p>
101 <p class="toc_element">
102 <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Creates a BackendBucket resource in the specified project using</p>
104 <p class="toc_element">
105 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Retrieves the list of BackendBucket resources available to the specified</p>
107 <p class="toc_element">
108 <code><a href="#listUsable">listUsable(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
109 <p class="firstline">Retrieves a list of all usable backend buckets in the specified project.</p>
110 <p class="toc_element">
111 <code><a href="#listUsable_next">listUsable_next()</a></code></p>
112 <p class="firstline">Retrieves the next page of results.</p>
113 <p class="toc_element">
114 <code><a href="#list_next">list_next()</a></code></p>
115 <p class="firstline">Retrieves the next page of results.</p>
116 <p class="toc_element">
117 <code><a href="#patch">patch(project, backendBucket, body=None, requestId=None, x__xgafv=None)</a></code></p>
118 <p class="firstline">Updates the specified BackendBucket resource with the data included in the</p>
119 <p class="toc_element">
120 <code><a href="#setEdgeSecurityPolicy">setEdgeSecurityPolicy(project, backendBucket, body=None, requestId=None, x__xgafv=None)</a></code></p>
121 <p class="firstline">Sets the edge security policy for the specified backend bucket.</p>
122 <p class="toc_element">
123 <code><a href="#setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</a></code></p>
124 <p class="firstline">Sets the access control policy on the specified resource.</p>
125 <p class="toc_element">
126 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p>
127 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
128 <p class="toc_element">
129 <code><a href="#update">update(project, backendBucket, body=None, requestId=None, x__xgafv=None)</a></code></p>
130 <p class="firstline">Updates the specified BackendBucket resource with the data included in the</p>
131 <h3>Method Details</h3>
132 <div class="method">
133 <code class="details" id="addSignedUrlKey">addSignedUrlKey(project, backendBucket, body=None, requestId=None, x__xgafv=None)</code>
134 <pre>Adds a key for validating requests with signed URLs for this backend
135 bucket.
136
137 Args:
138 project: string, Project ID for this request. (required)
139 backendBucket: string, Name of the BackendBucket resource to which the Signed URL Key should be
140 added. The name should conform to RFC1035. (required)
141 body: object, The request body.
142 The object takes the form of:
143
144 { # Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs
145 &quot;keyName&quot;: &quot;A String&quot;, # Name of the key. The name must be 1-63 characters long, and comply withRFC1035.
146 # Specifically, the name must be 1-63 characters long and match the regular
147 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
148 # character must be a lowercase letter, and all following characters must
149 # be a dash, lowercase letter, or digit, except the last character, which
150 # cannot be a dash.
151 &quot;keyValue&quot;: &quot;A String&quot;, # 128-bit key value used for signing the URL. The key value must be a validRFC
152 # 4648 Section 5 base64url encoded string.
153 }
154
155 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
156 that if you must retry your request, the server will know to ignore the
157 request if it has already been completed.
158
159 For example, consider a situation where you make an initial request and
160 the request times out. If you make the request again with the same
161 request ID, the server can check if original operation with the same
162 request ID was received, and if so, will ignore the second request. This
163 prevents clients from accidentally creating duplicate commitments.
164
165 The request ID must be
166 a valid UUID with the exception that zero UUID is not supported
167 (00000000-0000-0000-0000-000000000000).
168 x__xgafv: string, V1 error format.
169 Allowed values
170 1 - v1 error format
171 2 - v2 error format
172
173 Returns:
174 An object of the form:
175
176 { # Represents an Operation resource.
177 #
178 # Google Compute Engine has three Operation resources:
179 #
180 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
181 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
182 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
183 #
184 # You can use an operation resource to manage asynchronous API requests.
185 # For more information, readHandling
186 # API responses.
187 #
188 # Operations can be global, regional or zonal.
189 #
190 # - For global operations, use the `globalOperations`
191 # resource.
192 # - For regional operations, use the
193 # `regionOperations` resource.
194 # - For zonal operations, use
195 # the `zoneOperations` resource.
196 #
197 #
198 #
199 # For more information, read
200 # Global, Regional, and Zonal Resources.
201 #
202 # Note that completed Operation resources have a limited
203 # retention period.
204 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
205 # Not present otherwise.
206 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
207 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
208 # set when the operation is created.
209 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
210 # text format.
211 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
212 # this field will be populated.
213 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
214 # operation.
215 {
216 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
217 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
218 # details. There is a set of defined message types to use for providing
219 # details.The syntax depends on the error code. For example,
220 # QuotaExceededInfo will have details when the error code is
221 # QUOTA_EXCEEDED.
222 {
223 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
224 #
225 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
226 # is not enabled:
227 #
228 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
229 # &quot;domain&quot;: &quot;googleapis.com&quot;
230 # &quot;metadata&quot;: {
231 # &quot;resource&quot;: &quot;projects/123&quot;,
232 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
233 # }
234 # }
235 #
236 # This response indicates that the pubsub.googleapis.com API is not enabled.
237 #
238 # Example of an error that is returned when attempting to create a Spanner
239 # instance in a region that is out of stock:
240 #
241 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
242 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
243 # &quot;metadata&quot;: {
244 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
245 # }
246 # }
247 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
248 # is typically the registered service name of the tool or product that
249 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
250 # generated by some common infrastructure, the error domain must be a
251 # globally unique value that identifies the infrastructure. For Google API
252 # infrastructure, the error domain is &quot;googleapis.com&quot;.
253 &quot;metadatas&quot;: { # Additional structured details about this error.
254 #
255 # Keys must match a regular expression of `a-z+` but should
256 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
257 # length. When identifying the current value of an exceeded limit, the units
258 # should be contained in the key, not the value. For example, rather than
259 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
260 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
261 # instances that can be created in a single (batch) request.
262 &quot;a_key&quot;: &quot;A String&quot;,
263 },
264 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
265 # proximate cause of the error. Error reasons are unique within a particular
266 # domain of errors. This should be at most 63 characters and match a
267 # regular expression of `A-Z+[A-Z0-9]`, which represents
268 # UPPER_SNAKE_CASE.
269 },
270 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
271 #
272 # For example, if a quota check failed with an error indicating the calling
273 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
274 # directly to the right place in the developer console to flip the bit.
275 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
276 { # Describes a URL link.
277 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
278 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
279 },
280 ],
281 },
282 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
283 # which can be attached to an RPC error.
284 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
285 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
286 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
287 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
288 },
289 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
290 &quot;dimensions&quot;: { # The map holding related quota dimensions.
291 &quot;a_key&quot;: &quot;A String&quot;,
292 },
293 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
294 # type or metric.
295 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
296 # or metric.
297 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
298 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
299 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
300 },
301 },
302 ],
303 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
304 # This property is optional.
305 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
306 },
307 ],
308 },
309 &quot;getVersionOperationMetadata&quot;: {
310 &quot;inlineSbomInfo&quot;: {
311 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
312 # appropriate identifiers.
313 &quot;a_key&quot;: &quot;A String&quot;,
314 },
315 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
316 # identifiers.
317 &quot;a_key&quot;: &quot;A String&quot;,
318 },
319 },
320 },
321 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
322 # message that was returned, such as `NOT FOUND`.
323 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
324 # status code that was returned. For example, a `404` means the
325 # resource was not found.
326 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
327 # defined by the server.
328 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
329 # This value is inRFC3339
330 # text format.
331 &quot;instancesBulkInsertOperationMetadata&quot;: {
332 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
333 # Example key: zones/us-central1-a
334 &quot;a_key&quot;: {
335 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
336 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
337 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
338 # error.
339 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
340 # if the flow is rolling forward or rolling back.
341 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
342 },
343 },
344 },
345 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
346 # Operation resources.
347 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
348 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
349 # group of operations results from a `bulkInsert` API request.
350 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
351 # `update`, or `delete`, and so on.
352 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
353 # There is no requirement that this be linear or support any granularity of
354 # operations. This should not be used to guess when the operation will be
355 # complete. This number should monotonically increase as the operation
356 # progresses.
357 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
358 # applicable when performing regional operations.
359 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
360 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
361 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
362 # this field will contain information on all underlying zonal actions and
363 # their state.
364 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
365 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
366 # Example key: zones/us-central1-a
367 &quot;a_key&quot;: {
368 &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
369 # populated.
370 # different programming environments, including REST APIs and RPC APIs. It is
371 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
372 # three pieces of data: error code, error message, and error details.
373 #
374 # You can find out more about this error model and how to work with it in the
375 # [API Design Guide](https://cloud.google.com/apis/design/errors).
376 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
377 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
378 # message types for APIs to use.
379 {
380 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
381 },
382 ],
383 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
384 # user-facing error message should be localized and sent in the
385 # google.rpc.Status.details field, or localized by the client.
386 },
387 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
388 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
389 },
390 },
391 },
392 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
393 # This value is inRFC3339
394 # text format.
395 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
396 # following:
397 # `PENDING`, `RUNNING`, or `DONE`.
398 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
399 # operation.
400 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
401 # of the target resource.
402 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
403 # operations related to creating a snapshot, this points to the disk
404 # that the snapshot was created from.
405 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
406 # `[email protected]` or
407 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
408 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
409 # operation, this field will be populated.
410 {
411 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
412 # Engine returns NO_RESULTS_ON_PAGE if there
413 # are no results in the response.
414 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
415 # value format. For example:
416 #
417 # &quot;data&quot;: [
418 # {
419 # &quot;key&quot;: &quot;scope&quot;,
420 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
421 # }
422 {
423 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
424 # returned. For example, for warnings where there are no results in a list
425 # request for a particular zone, this key might be scope and
426 # the key value might be the zone name. Other examples might be a key
427 # indicating a deprecated resource and a suggested replacement, or a
428 # warning about invalid network settings (for example, if an instance
429 # attempts to perform IP forwarding but is not enabled for IP forwarding).
430 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
431 },
432 ],
433 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
434 },
435 ],
436 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
437 # applicable when performing per-zone operations.
438 }</pre>
439 </div>
440
441 <div class="method">
442 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</code>
443 <pre>Retrieves the list of all BackendBucket resources, regional and global,
444 available to the specified project.
445
446 To prevent failure, it is recommended that you set the
447 `returnPartialSuccess` parameter to `true`.
448
449 Args:
450 project: string, Name of the project scoping this request. (required)
451 filter: string, A filter expression that filters resources listed in the response. Most
452 Compute resources support two types of filter expressions:
453 expressions that support regular expressions and expressions that follow
454 API improvement proposal AIP-160.
455 These two types of filter expressions cannot be mixed in one request.
456
457 If you want to use AIP-160, your expression must specify the field name, an
458 operator, and the value that you want to use for filtering. The value
459 must be a string, a number, or a boolean. The operator
460 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
461
462 For example, if you are filtering Compute Engine instances, you can
463 exclude instances named `example-instance` by specifying
464 `name != example-instance`.
465
466 The `:*` comparison can be used to test whether a key has been defined.
467 For example, to find all objects with `owner` label use:
468 ```
469 labels.owner:*
470 ```
471
472 You can also filter nested fields. For example, you could specify
473 `scheduling.automaticRestart = false` to include instances only
474 if they are not scheduled for automatic restarts. You can use filtering
475 on nested fields to filter based onresource labels.
476
477 To filter on multiple expressions, provide each separate expression within
478 parentheses. For example:
479 ```
480 (scheduling.automaticRestart = true)
481 (cpuPlatform = &quot;Intel Skylake&quot;)
482 ```
483 By default, each expression is an `AND` expression. However, you
484 can include `AND` and `OR` expressions explicitly.
485 For example:
486 ```
487 (cpuPlatform = &quot;Intel Skylake&quot;) OR
488 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
489 (scheduling.automaticRestart = true)
490 ```
491
492 If you want to use a regular expression, use the `eq` (equal) or `ne`
493 (not equal) operator against a single un-parenthesized expression with or
494 without quotes or against multiple parenthesized expressions. Examples:
495
496 `fieldname eq unquoted literal`
497 `fieldname eq &#x27;single quoted literal&#x27;`
498 `fieldname eq &quot;double quoted literal&quot;`
499 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
500
501 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
502 The literal value must match the entire field.
503
504 For example, to filter for instances that do not end with name &quot;instance&quot;,
505 you would use `name ne .*instance`.
506
507 You cannot combine constraints on multiple fields using regular
508 expressions.
509 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
510 global) should be included in the response. For new resource types added
511 after this field, the flag has no effect as new resource types will always
512 include every visible scope for each scope type in response. For resource
513 types which predate this field, if this flag is omitted or false, only
514 scopes of the scope types where the resource type is expected to be found
515 will be included.
516 maxResults: integer, The maximum number of results per page that should be returned.
517 If the number of available results is larger than `maxResults`,
518 Compute Engine returns a `nextPageToken` that can be used to get
519 the next page of results in subsequent list requests. Acceptable values are
520 `0` to `500`, inclusive. (Default: `500`)
521 orderBy: string, Sorts list results by a certain order. By default, results
522 are returned in alphanumerical order based on the resource name.
523
524 You can also sort results in descending order based on the creation
525 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
526 results based on the `creationTimestamp` field in
527 reverse chronological order (newest result first). Use this to sort
528 resources like operations so that the newest operation is returned first.
529
530 Currently, only sorting by `name` or
531 `creationTimestamp desc` is supported.
532 pageToken: string, Specifies a page token to use. Set `pageToken` to the
533 `nextPageToken` returned by a previous list request to get
534 the next page of results.
535 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
536 of failure. The default value is false.
537
538 For example, when partial success behavior is enabled, aggregatedList for a
539 single zone scope either returns all resources in the zone or no resources,
540 with an error code.
541 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
542 aggregated list request is invoked for subnetworks list-usable api.
543 x__xgafv: string, V1 error format.
544 Allowed values
545 1 - v1 error format
546 2 - v2 error format
547
548 Returns:
549 An object of the form:
550
551 {
552 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
553 &quot;items&quot;: { # A list of BackendBucketsScopedList resources.
554 &quot;a_key&quot;: { # Name of the scope containing this set of BackendBuckets.
555 &quot;backendBuckets&quot;: [ # A list of BackendBuckets contained in this scope.
556 { # Represents a Cloud Storage Bucket resource.
557 #
558 # This Cloud Storage bucket resource is referenced by a URL map of a load
559 # balancer. For more information, readBackend Buckets.
560 &quot;bucketName&quot;: &quot;A String&quot;, # Cloud Storage bucket name.
561 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket.
562 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
563 # Pragma or Authorization headers. Up to 5 headers can be specified.
564 # The cache is bypassed for all cdnPolicy.cacheMode settings.
565 { # Bypass the cache when the specified request headers are present,
566 # e.g. Pragma or Authorization headers. Values are case insensitive.
567 # The presence of such a header overrides the cache_mode setting.
568 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
569 # Values are case-insensitive.
570 },
571 ],
572 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for # The CacheKeyPolicy for this CdnPolicy.
573 # Cloud CDN.
574 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
575 &quot;A String&quot;,
576 ],
577 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. Default
578 # parameters are always included. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded
579 # and not treated as delimiters.
580 &quot;A String&quot;,
581 ],
582 },
583 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
584 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
585 # headers to cache content. Responses without these headers will not be
586 # cached at Google&#x27;s edge, and will require a full trip to the origin on
587 # every request, potentially impacting performance and increasing load on
588 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
589 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
590 # Warning: this may result in Cloud CDN caching private,
591 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
592 # including common image formats, media (video and audio), and web assets
593 # (JavaScript and CSS). Requests and responses that are marked as
594 # uncacheable, as well as dynamic content (including HTML), will not be
595 # cached.
596 #
597 # If no value is provided for cdnPolicy.cacheMode, it defaults
598 # to CACHE_ALL_STATIC.
599 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
600 # used to clamp the max-age (or Expires) value sent to the client. With
601 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
602 # response max-age directive, along with a &quot;public&quot; directive. For
603 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
604 # from the origin (if specified), or else sets the response max-age
605 # directive to the lesser of the client_ttl and default_ttl, and also
606 # ensures a &quot;public&quot; cache-control directive is present.
607 # If a client TTL is not specified, a default value (1 hour) will be used.
608 # The maximum allowed value is 31,622,400s (1 year).
609 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
610 # responses that do not have an existing valid TTL (max-age or s-maxage).
611 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
612 # The value of defaultTTL cannot be set to a value greater than that of
613 # maxTTL, but can be equal.
614 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
615 # will overwrite the TTL set in all responses. The maximum allowed value is
616 # 31,622,400s (1 year), noting that infrequently accessed objects may be
617 # evicted from the cache before the defined TTL.
618 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
619 # origin.
620 # Cache directives that attempt to set a max-age or s-maxage higher than
621 # this, or an Expires header more than maxTTL seconds in the future will
622 # be capped at the value of maxTTL, as if it were the value of an
623 # s-maxage Cache-Control directive.
624 # Headers sent to the client will not be modified.
625 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
626 # The maximum allowed value is 31,622,400s (1 year), noting that
627 # infrequently accessed objects may be evicted from the cache before
628 # the defined TTL.
629 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
630 # to apply fine-grained caching for common errors or redirects.
631 # This can reduce the load on your origin and improve end-user
632 # experience by reducing response latency.
633 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
634 # negative caching applies to responses with the specified response code
635 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
636 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
637 # to all responses with the specified response code, and override any
638 # caching headers.
639 # By default, Cloud CDN will apply the following default TTLs to these
640 # status codes:
641 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
642 # HTTP 404 (Not Found), 410 (Gone),
643 # 451 (Unavailable For Legal Reasons): 120s
644 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
645 # These defaults can be overridden in negative_caching_policy.
646 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
647 # negative_caching must be enabled to configure negative_caching_policy.
648 # Omitting the policy and leaving negative_caching enabled will use
649 # Cloud CDN&#x27;s default cache TTLs.
650 # Note that when specifying an explicit negative_caching_policy, you
651 # should take care to specify a cache TTL for all response codes
652 # that you wish to cache. Cloud CDN will not apply any default
653 # negative caching when a policy exists.
654 { # Specify CDN TTLs for response error codes.
655 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
656 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
657 # specified as values, and you cannot specify a status code more than
658 # once.
659 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
660 # corresponding status code.
661 # The maximum allowed value is 1800s (30 minutes), noting that
662 # infrequently accessed objects may be evicted from the cache before the
663 # defined TTL.
664 },
665 ],
666 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
667 # requests into a small number of requests to the origin.
668 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
669 # content with the origin, or when an error is encountered when refreshing
670 # the cache.
671 # This setting defines the default &quot;max-stale&quot; duration for any cached
672 # responses that do not specify a max-stale directive. Stale responses that
673 # exceed the TTL configured here will not be served. The default limit
674 # (max-stale) is 86400s (1 day), which will allow stale content to be
675 # served up to this limit beyond the max-age (or s-maxage) of a cached
676 # response.
677 # The maximum allowed value is 604800 (1 week).
678 # Set this to zero (0) to disable serve-while-stale.
679 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
680 # considered fresh. After this time period, the response will be
681 # revalidated before being served. Defaults to 1hr (3600s). When serving
682 # responses to signed URL requests, Cloud CDN will internally behave as
683 # though all responses from this backend had a &quot;Cache-Control:
684 # public, max-age=[TTL]&quot; header, regardless of any existing
685 # Cache-Control header. The actual headers served in responses will not be
686 # altered.
687 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
688 &quot;A String&quot;,
689 ],
690 },
691 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
692 # the client&#x27;s Accept-Encoding header.
693 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
694 # text format.
695 &quot;customResponseHeaders&quot;: [ # Headers that the Application Load Balancer should add to proxied responses.
696 &quot;A String&quot;,
697 ],
698 &quot;description&quot;: &quot;A String&quot;, # An optional textual description of the resource; provided by the client
699 # when the resource is created.
700 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
701 # this backend bucket.
702 &quot;enableCdn&quot;: True or False, # If true, enable Cloud CDN for this BackendBucket.
703 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
704 &quot;kind&quot;: &quot;compute#backendBucket&quot;, # Output only. Type of the resource.
705 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # The value can only be INTERNAL_MANAGED for cross-region internal layer 7
706 # load balancer.
707 #
708 # If loadBalancingScheme is not specified, the backend bucket can be used by
709 # classic global external load balancers, or global application external load
710 # balancers, or both.
711 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
712 # The name must be 1-63 characters long, and comply withRFC1035.
713 # Specifically, the name must be 1-63 characters long and match the regular
714 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
715 # character must be a lowercase letter, and all following characters must
716 # be a dash, lowercase letter, or digit, except the last character, which
717 # cannot be a dash.
718 &quot;params&quot;: { # Additional Backend Bucket parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
719 # as part of resource payload.
720 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
721 # Tag keys and values have the same definition as resource
722 # manager tags. The field is allowed for INSERT
723 # only. The keys/values to set on the resource should be specified in
724 # either ID { : } or Namespaced format
725 # { : }.
726 # For example the following are valid inputs:
727 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
728 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
729 # Note:
730 # * Invalid combinations of ID &amp; namespaced format is not supported. For
731 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
732 &quot;a_key&quot;: &quot;A String&quot;,
733 },
734 },
735 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend bucket
736 # resides. This field is not applicable to global backend buckets.
737 # You must specify this field as part of the HTTP request URL. It is
738 # not settable as a field in the request body.
739 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
740 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
741 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing that backend bucket.
742 {
743 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for UrlMaps referencing that
744 # BackendBucket.
745 },
746 ],
747 },
748 ],
749 &quot;warning&quot;: { # Informational warning which replaces the list of
750 # backend services when the list is empty.
751 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
752 # Engine returns NO_RESULTS_ON_PAGE if there
753 # are no results in the response.
754 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
755 # value format. For example:
756 #
757 # &quot;data&quot;: [
758 # {
759 # &quot;key&quot;: &quot;scope&quot;,
760 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
761 # }
762 {
763 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
764 # returned. For example, for warnings where there are no results in a list
765 # request for a particular zone, this key might be scope and
766 # the key value might be the zone name. Other examples might be a key
767 # indicating a deprecated resource and a suggested replacement, or a
768 # warning about invalid network settings (for example, if an instance
769 # attempts to perform IP forwarding but is not enabled for IP forwarding).
770 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
771 },
772 ],
773 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
774 },
775 },
776 },
777 &quot;kind&quot;: &quot;compute#backendBucketAggregatedList&quot;, # Output only. Type of resource.
778 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
779 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
780 # the query parameter pageToken in the next list request.
781 # Subsequent list requests will have their own nextPageToken to
782 # continue paging through the results.
783 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
784 &quot;warning&quot;: { # [Output Only] Informational warning message.
785 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
786 # Engine returns NO_RESULTS_ON_PAGE if there
787 # are no results in the response.
788 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
789 # value format. For example:
790 #
791 # &quot;data&quot;: [
792 # {
793 # &quot;key&quot;: &quot;scope&quot;,
794 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
795 # }
796 {
797 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
798 # returned. For example, for warnings where there are no results in a list
799 # request for a particular zone, this key might be scope and
800 # the key value might be the zone name. Other examples might be a key
801 # indicating a deprecated resource and a suggested replacement, or a
802 # warning about invalid network settings (for example, if an instance
803 # attempts to perform IP forwarding but is not enabled for IP forwarding).
804 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
805 },
806 ],
807 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
808 },
809 }</pre>
810 </div>
811
812 <div class="method">
813 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
814 <pre>Retrieves the next page of results.
815
816 Args:
817 previous_request: The request for the previous page. (required)
818 previous_response: The response from the request for the previous page. (required)
819
820 Returns:
821 A request object that you can call &#x27;execute()&#x27; on to request the next
822 page. Returns None if there are no more items in the collection.
823 </pre>
824 </div>
825
826 <div class="method">
827 <code class="details" id="close">close()</code>
828 <pre>Close httplib2 connections.</pre>
829 </div>
830
831 <div class="method">
832 <code class="details" id="delete">delete(project, backendBucket, requestId=None, x__xgafv=None)</code>
833 <pre>Deletes the specified BackendBucket resource.
834
835 Args:
836 project: string, Project ID for this request. (required)
837 backendBucket: string, Name of the BackendBucket resource to delete. (required)
838 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
839 that if you must retry your request, the server will know to ignore the
840 request if it has already been completed.
841
842 For example, consider a situation where you make an initial request and
843 the request times out. If you make the request again with the same
844 request ID, the server can check if original operation with the same
845 request ID was received, and if so, will ignore the second request. This
846 prevents clients from accidentally creating duplicate commitments.
847
848 The request ID must be
849 a valid UUID with the exception that zero UUID is not supported
850 (00000000-0000-0000-0000-000000000000).
851 x__xgafv: string, V1 error format.
852 Allowed values
853 1 - v1 error format
854 2 - v2 error format
855
856 Returns:
857 An object of the form:
858
859 { # Represents an Operation resource.
860 #
861 # Google Compute Engine has three Operation resources:
862 #
863 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
864 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
865 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
866 #
867 # You can use an operation resource to manage asynchronous API requests.
868 # For more information, readHandling
869 # API responses.
870 #
871 # Operations can be global, regional or zonal.
872 #
873 # - For global operations, use the `globalOperations`
874 # resource.
875 # - For regional operations, use the
876 # `regionOperations` resource.
877 # - For zonal operations, use
878 # the `zoneOperations` resource.
879 #
880 #
881 #
882 # For more information, read
883 # Global, Regional, and Zonal Resources.
884 #
885 # Note that completed Operation resources have a limited
886 # retention period.
887 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
888 # Not present otherwise.
889 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
890 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
891 # set when the operation is created.
892 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
893 # text format.
894 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
895 # this field will be populated.
896 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
897 # operation.
898 {
899 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
900 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
901 # details. There is a set of defined message types to use for providing
902 # details.The syntax depends on the error code. For example,
903 # QuotaExceededInfo will have details when the error code is
904 # QUOTA_EXCEEDED.
905 {
906 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
907 #
908 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
909 # is not enabled:
910 #
911 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
912 # &quot;domain&quot;: &quot;googleapis.com&quot;
913 # &quot;metadata&quot;: {
914 # &quot;resource&quot;: &quot;projects/123&quot;,
915 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
916 # }
917 # }
918 #
919 # This response indicates that the pubsub.googleapis.com API is not enabled.
920 #
921 # Example of an error that is returned when attempting to create a Spanner
922 # instance in a region that is out of stock:
923 #
924 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
925 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
926 # &quot;metadata&quot;: {
927 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
928 # }
929 # }
930 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
931 # is typically the registered service name of the tool or product that
932 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
933 # generated by some common infrastructure, the error domain must be a
934 # globally unique value that identifies the infrastructure. For Google API
935 # infrastructure, the error domain is &quot;googleapis.com&quot;.
936 &quot;metadatas&quot;: { # Additional structured details about this error.
937 #
938 # Keys must match a regular expression of `a-z+` but should
939 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
940 # length. When identifying the current value of an exceeded limit, the units
941 # should be contained in the key, not the value. For example, rather than
942 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
943 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
944 # instances that can be created in a single (batch) request.
945 &quot;a_key&quot;: &quot;A String&quot;,
946 },
947 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
948 # proximate cause of the error. Error reasons are unique within a particular
949 # domain of errors. This should be at most 63 characters and match a
950 # regular expression of `A-Z+[A-Z0-9]`, which represents
951 # UPPER_SNAKE_CASE.
952 },
953 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
954 #
955 # For example, if a quota check failed with an error indicating the calling
956 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
957 # directly to the right place in the developer console to flip the bit.
958 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
959 { # Describes a URL link.
960 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
961 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
962 },
963 ],
964 },
965 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
966 # which can be attached to an RPC error.
967 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
968 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
969 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
970 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
971 },
972 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
973 &quot;dimensions&quot;: { # The map holding related quota dimensions.
974 &quot;a_key&quot;: &quot;A String&quot;,
975 },
976 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
977 # type or metric.
978 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
979 # or metric.
980 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
981 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
982 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
983 },
984 },
985 ],
986 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
987 # This property is optional.
988 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
989 },
990 ],
991 },
992 &quot;getVersionOperationMetadata&quot;: {
993 &quot;inlineSbomInfo&quot;: {
994 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
995 # appropriate identifiers.
996 &quot;a_key&quot;: &quot;A String&quot;,
997 },
998 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
999 # identifiers.
1000 &quot;a_key&quot;: &quot;A String&quot;,
1001 },
1002 },
1003 },
1004 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1005 # message that was returned, such as `NOT FOUND`.
1006 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1007 # status code that was returned. For example, a `404` means the
1008 # resource was not found.
1009 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1010 # defined by the server.
1011 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1012 # This value is inRFC3339
1013 # text format.
1014 &quot;instancesBulkInsertOperationMetadata&quot;: {
1015 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1016 # Example key: zones/us-central1-a
1017 &quot;a_key&quot;: {
1018 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1019 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1020 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1021 # error.
1022 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1023 # if the flow is rolling forward or rolling back.
1024 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1025 },
1026 },
1027 },
1028 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1029 # Operation resources.
1030 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1031 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1032 # group of operations results from a `bulkInsert` API request.
1033 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1034 # `update`, or `delete`, and so on.
1035 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1036 # There is no requirement that this be linear or support any granularity of
1037 # operations. This should not be used to guess when the operation will be
1038 # complete. This number should monotonically increase as the operation
1039 # progresses.
1040 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1041 # applicable when performing regional operations.
1042 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1043 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1044 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1045 # this field will contain information on all underlying zonal actions and
1046 # their state.
1047 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1048 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1049 # Example key: zones/us-central1-a
1050 &quot;a_key&quot;: {
1051 &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
1052 # populated.
1053 # different programming environments, including REST APIs and RPC APIs. It is
1054 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1055 # three pieces of data: error code, error message, and error details.
1056 #
1057 # You can find out more about this error model and how to work with it in the
1058 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1059 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1060 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1061 # message types for APIs to use.
1062 {
1063 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1064 },
1065 ],
1066 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1067 # user-facing error message should be localized and sent in the
1068 # google.rpc.Status.details field, or localized by the client.
1069 },
1070 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1071 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1072 },
1073 },
1074 },
1075 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1076 # This value is inRFC3339
1077 # text format.
1078 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1079 # following:
1080 # `PENDING`, `RUNNING`, or `DONE`.
1081 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1082 # operation.
1083 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1084 # of the target resource.
1085 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1086 # operations related to creating a snapshot, this points to the disk
1087 # that the snapshot was created from.
1088 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1089 # `[email protected]` or
1090 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1091 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1092 # operation, this field will be populated.
1093 {
1094 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1095 # Engine returns NO_RESULTS_ON_PAGE if there
1096 # are no results in the response.
1097 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1098 # value format. For example:
1099 #
1100 # &quot;data&quot;: [
1101 # {
1102 # &quot;key&quot;: &quot;scope&quot;,
1103 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1104 # }
1105 {
1106 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1107 # returned. For example, for warnings where there are no results in a list
1108 # request for a particular zone, this key might be scope and
1109 # the key value might be the zone name. Other examples might be a key
1110 # indicating a deprecated resource and a suggested replacement, or a
1111 # warning about invalid network settings (for example, if an instance
1112 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1113 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1114 },
1115 ],
1116 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1117 },
1118 ],
1119 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1120 # applicable when performing per-zone operations.
1121 }</pre>
1122 </div>
1123
1124 <div class="method">
1125 <code class="details" id="deleteSignedUrlKey">deleteSignedUrlKey(project, backendBucket, keyName, requestId=None, x__xgafv=None)</code>
1126 <pre>Deletes a key for validating requests with signed URLs for this backend
1127 bucket.
1128
1129 Args:
1130 project: string, Project ID for this request. (required)
1131 backendBucket: string, Name of the BackendBucket resource to which the Signed URL Key should be
1132 added. The name should conform to RFC1035. (required)
1133 keyName: string, The name of the Signed URL Key to delete. (required)
1134 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1135 that if you must retry your request, the server will know to ignore the
1136 request if it has already been completed.
1137
1138 For example, consider a situation where you make an initial request and
1139 the request times out. If you make the request again with the same
1140 request ID, the server can check if original operation with the same
1141 request ID was received, and if so, will ignore the second request. This
1142 prevents clients from accidentally creating duplicate commitments.
1143
1144 The request ID must be
1145 a valid UUID with the exception that zero UUID is not supported
1146 (00000000-0000-0000-0000-000000000000).
1147 x__xgafv: string, V1 error format.
1148 Allowed values
1149 1 - v1 error format
1150 2 - v2 error format
1151
1152 Returns:
1153 An object of the form:
1154
1155 { # Represents an Operation resource.
1156 #
1157 # Google Compute Engine has three Operation resources:
1158 #
1159 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
1160 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
1161 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
1162 #
1163 # You can use an operation resource to manage asynchronous API requests.
1164 # For more information, readHandling
1165 # API responses.
1166 #
1167 # Operations can be global, regional or zonal.
1168 #
1169 # - For global operations, use the `globalOperations`
1170 # resource.
1171 # - For regional operations, use the
1172 # `regionOperations` resource.
1173 # - For zonal operations, use
1174 # the `zoneOperations` resource.
1175 #
1176 #
1177 #
1178 # For more information, read
1179 # Global, Regional, and Zonal Resources.
1180 #
1181 # Note that completed Operation resources have a limited
1182 # retention period.
1183 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1184 # Not present otherwise.
1185 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1186 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1187 # set when the operation is created.
1188 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1189 # text format.
1190 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1191 # this field will be populated.
1192 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1193 # operation.
1194 {
1195 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1196 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1197 # details. There is a set of defined message types to use for providing
1198 # details.The syntax depends on the error code. For example,
1199 # QuotaExceededInfo will have details when the error code is
1200 # QUOTA_EXCEEDED.
1201 {
1202 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1203 #
1204 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1205 # is not enabled:
1206 #
1207 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1208 # &quot;domain&quot;: &quot;googleapis.com&quot;
1209 # &quot;metadata&quot;: {
1210 # &quot;resource&quot;: &quot;projects/123&quot;,
1211 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1212 # }
1213 # }
1214 #
1215 # This response indicates that the pubsub.googleapis.com API is not enabled.
1216 #
1217 # Example of an error that is returned when attempting to create a Spanner
1218 # instance in a region that is out of stock:
1219 #
1220 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1221 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1222 # &quot;metadata&quot;: {
1223 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1224 # }
1225 # }
1226 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1227 # is typically the registered service name of the tool or product that
1228 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1229 # generated by some common infrastructure, the error domain must be a
1230 # globally unique value that identifies the infrastructure. For Google API
1231 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1232 &quot;metadatas&quot;: { # Additional structured details about this error.
1233 #
1234 # Keys must match a regular expression of `a-z+` but should
1235 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1236 # length. When identifying the current value of an exceeded limit, the units
1237 # should be contained in the key, not the value. For example, rather than
1238 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1239 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1240 # instances that can be created in a single (batch) request.
1241 &quot;a_key&quot;: &quot;A String&quot;,
1242 },
1243 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1244 # proximate cause of the error. Error reasons are unique within a particular
1245 # domain of errors. This should be at most 63 characters and match a
1246 # regular expression of `A-Z+[A-Z0-9]`, which represents
1247 # UPPER_SNAKE_CASE.
1248 },
1249 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1250 #
1251 # For example, if a quota check failed with an error indicating the calling
1252 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1253 # directly to the right place in the developer console to flip the bit.
1254 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1255 { # Describes a URL link.
1256 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1257 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1258 },
1259 ],
1260 },
1261 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1262 # which can be attached to an RPC error.
1263 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1264 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1265 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1266 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1267 },
1268 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1269 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1270 &quot;a_key&quot;: &quot;A String&quot;,
1271 },
1272 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1273 # type or metric.
1274 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1275 # or metric.
1276 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1277 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1278 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1279 },
1280 },
1281 ],
1282 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1283 # This property is optional.
1284 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1285 },
1286 ],
1287 },
1288 &quot;getVersionOperationMetadata&quot;: {
1289 &quot;inlineSbomInfo&quot;: {
1290 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1291 # appropriate identifiers.
1292 &quot;a_key&quot;: &quot;A String&quot;,
1293 },
1294 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1295 # identifiers.
1296 &quot;a_key&quot;: &quot;A String&quot;,
1297 },
1298 },
1299 },
1300 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1301 # message that was returned, such as `NOT FOUND`.
1302 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1303 # status code that was returned. For example, a `404` means the
1304 # resource was not found.
1305 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1306 # defined by the server.
1307 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1308 # This value is inRFC3339
1309 # text format.
1310 &quot;instancesBulkInsertOperationMetadata&quot;: {
1311 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1312 # Example key: zones/us-central1-a
1313 &quot;a_key&quot;: {
1314 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1315 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1316 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1317 # error.
1318 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1319 # if the flow is rolling forward or rolling back.
1320 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1321 },
1322 },
1323 },
1324 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1325 # Operation resources.
1326 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1327 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1328 # group of operations results from a `bulkInsert` API request.
1329 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1330 # `update`, or `delete`, and so on.
1331 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1332 # There is no requirement that this be linear or support any granularity of
1333 # operations. This should not be used to guess when the operation will be
1334 # complete. This number should monotonically increase as the operation
1335 # progresses.
1336 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1337 # applicable when performing regional operations.
1338 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1339 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1340 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1341 # this field will contain information on all underlying zonal actions and
1342 # their state.
1343 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1344 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1345 # Example key: zones/us-central1-a
1346 &quot;a_key&quot;: {
1347 &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
1348 # populated.
1349 # different programming environments, including REST APIs and RPC APIs. It is
1350 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1351 # three pieces of data: error code, error message, and error details.
1352 #
1353 # You can find out more about this error model and how to work with it in the
1354 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1355 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1356 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1357 # message types for APIs to use.
1358 {
1359 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1360 },
1361 ],
1362 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1363 # user-facing error message should be localized and sent in the
1364 # google.rpc.Status.details field, or localized by the client.
1365 },
1366 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1367 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1368 },
1369 },
1370 },
1371 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1372 # This value is inRFC3339
1373 # text format.
1374 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1375 # following:
1376 # `PENDING`, `RUNNING`, or `DONE`.
1377 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1378 # operation.
1379 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1380 # of the target resource.
1381 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1382 # operations related to creating a snapshot, this points to the disk
1383 # that the snapshot was created from.
1384 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1385 # `[email protected]` or
1386 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1387 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1388 # operation, this field will be populated.
1389 {
1390 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1391 # Engine returns NO_RESULTS_ON_PAGE if there
1392 # are no results in the response.
1393 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1394 # value format. For example:
1395 #
1396 # &quot;data&quot;: [
1397 # {
1398 # &quot;key&quot;: &quot;scope&quot;,
1399 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1400 # }
1401 {
1402 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1403 # returned. For example, for warnings where there are no results in a list
1404 # request for a particular zone, this key might be scope and
1405 # the key value might be the zone name. Other examples might be a key
1406 # indicating a deprecated resource and a suggested replacement, or a
1407 # warning about invalid network settings (for example, if an instance
1408 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1409 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1410 },
1411 ],
1412 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1413 },
1414 ],
1415 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1416 # applicable when performing per-zone operations.
1417 }</pre>
1418 </div>
1419
1420 <div class="method">
1421 <code class="details" id="get">get(project, backendBucket, x__xgafv=None)</code>
1422 <pre>Returns the specified BackendBucket resource.
1423
1424 Args:
1425 project: string, Project ID for this request. (required)
1426 backendBucket: string, Name of the BackendBucket resource to return. (required)
1427 x__xgafv: string, V1 error format.
1428 Allowed values
1429 1 - v1 error format
1430 2 - v2 error format
1431
1432 Returns:
1433 An object of the form:
1434
1435 { # Represents a Cloud Storage Bucket resource.
1436 #
1437 # This Cloud Storage bucket resource is referenced by a URL map of a load
1438 # balancer. For more information, readBackend Buckets.
1439 &quot;bucketName&quot;: &quot;A String&quot;, # Cloud Storage bucket name.
1440 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket.
1441 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
1442 # Pragma or Authorization headers. Up to 5 headers can be specified.
1443 # The cache is bypassed for all cdnPolicy.cacheMode settings.
1444 { # Bypass the cache when the specified request headers are present,
1445 # e.g. Pragma or Authorization headers. Values are case insensitive.
1446 # The presence of such a header overrides the cache_mode setting.
1447 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
1448 # Values are case-insensitive.
1449 },
1450 ],
1451 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for # The CacheKeyPolicy for this CdnPolicy.
1452 # Cloud CDN.
1453 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
1454 &quot;A String&quot;,
1455 ],
1456 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. Default
1457 # parameters are always included. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded
1458 # and not treated as delimiters.
1459 &quot;A String&quot;,
1460 ],
1461 },
1462 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
1463 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
1464 # headers to cache content. Responses without these headers will not be
1465 # cached at Google&#x27;s edge, and will require a full trip to the origin on
1466 # every request, potentially impacting performance and increasing load on
1467 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
1468 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
1469 # Warning: this may result in Cloud CDN caching private,
1470 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
1471 # including common image formats, media (video and audio), and web assets
1472 # (JavaScript and CSS). Requests and responses that are marked as
1473 # uncacheable, as well as dynamic content (including HTML), will not be
1474 # cached.
1475 #
1476 # If no value is provided for cdnPolicy.cacheMode, it defaults
1477 # to CACHE_ALL_STATIC.
1478 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
1479 # used to clamp the max-age (or Expires) value sent to the client. With
1480 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
1481 # response max-age directive, along with a &quot;public&quot; directive. For
1482 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
1483 # from the origin (if specified), or else sets the response max-age
1484 # directive to the lesser of the client_ttl and default_ttl, and also
1485 # ensures a &quot;public&quot; cache-control directive is present.
1486 # If a client TTL is not specified, a default value (1 hour) will be used.
1487 # The maximum allowed value is 31,622,400s (1 year).
1488 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
1489 # responses that do not have an existing valid TTL (max-age or s-maxage).
1490 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
1491 # The value of defaultTTL cannot be set to a value greater than that of
1492 # maxTTL, but can be equal.
1493 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
1494 # will overwrite the TTL set in all responses. The maximum allowed value is
1495 # 31,622,400s (1 year), noting that infrequently accessed objects may be
1496 # evicted from the cache before the defined TTL.
1497 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
1498 # origin.
1499 # Cache directives that attempt to set a max-age or s-maxage higher than
1500 # this, or an Expires header more than maxTTL seconds in the future will
1501 # be capped at the value of maxTTL, as if it were the value of an
1502 # s-maxage Cache-Control directive.
1503 # Headers sent to the client will not be modified.
1504 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
1505 # The maximum allowed value is 31,622,400s (1 year), noting that
1506 # infrequently accessed objects may be evicted from the cache before
1507 # the defined TTL.
1508 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
1509 # to apply fine-grained caching for common errors or redirects.
1510 # This can reduce the load on your origin and improve end-user
1511 # experience by reducing response latency.
1512 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
1513 # negative caching applies to responses with the specified response code
1514 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
1515 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
1516 # to all responses with the specified response code, and override any
1517 # caching headers.
1518 # By default, Cloud CDN will apply the following default TTLs to these
1519 # status codes:
1520 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
1521 # HTTP 404 (Not Found), 410 (Gone),
1522 # 451 (Unavailable For Legal Reasons): 120s
1523 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
1524 # These defaults can be overridden in negative_caching_policy.
1525 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
1526 # negative_caching must be enabled to configure negative_caching_policy.
1527 # Omitting the policy and leaving negative_caching enabled will use
1528 # Cloud CDN&#x27;s default cache TTLs.
1529 # Note that when specifying an explicit negative_caching_policy, you
1530 # should take care to specify a cache TTL for all response codes
1531 # that you wish to cache. Cloud CDN will not apply any default
1532 # negative caching when a policy exists.
1533 { # Specify CDN TTLs for response error codes.
1534 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
1535 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
1536 # specified as values, and you cannot specify a status code more than
1537 # once.
1538 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
1539 # corresponding status code.
1540 # The maximum allowed value is 1800s (30 minutes), noting that
1541 # infrequently accessed objects may be evicted from the cache before the
1542 # defined TTL.
1543 },
1544 ],
1545 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
1546 # requests into a small number of requests to the origin.
1547 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
1548 # content with the origin, or when an error is encountered when refreshing
1549 # the cache.
1550 # This setting defines the default &quot;max-stale&quot; duration for any cached
1551 # responses that do not specify a max-stale directive. Stale responses that
1552 # exceed the TTL configured here will not be served. The default limit
1553 # (max-stale) is 86400s (1 day), which will allow stale content to be
1554 # served up to this limit beyond the max-age (or s-maxage) of a cached
1555 # response.
1556 # The maximum allowed value is 604800 (1 week).
1557 # Set this to zero (0) to disable serve-while-stale.
1558 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
1559 # considered fresh. After this time period, the response will be
1560 # revalidated before being served. Defaults to 1hr (3600s). When serving
1561 # responses to signed URL requests, Cloud CDN will internally behave as
1562 # though all responses from this backend had a &quot;Cache-Control:
1563 # public, max-age=[TTL]&quot; header, regardless of any existing
1564 # Cache-Control header. The actual headers served in responses will not be
1565 # altered.
1566 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
1567 &quot;A String&quot;,
1568 ],
1569 },
1570 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
1571 # the client&#x27;s Accept-Encoding header.
1572 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
1573 # text format.
1574 &quot;customResponseHeaders&quot;: [ # Headers that the Application Load Balancer should add to proxied responses.
1575 &quot;A String&quot;,
1576 ],
1577 &quot;description&quot;: &quot;A String&quot;, # An optional textual description of the resource; provided by the client
1578 # when the resource is created.
1579 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
1580 # this backend bucket.
1581 &quot;enableCdn&quot;: True or False, # If true, enable Cloud CDN for this BackendBucket.
1582 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1583 &quot;kind&quot;: &quot;compute#backendBucket&quot;, # Output only. Type of the resource.
1584 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # The value can only be INTERNAL_MANAGED for cross-region internal layer 7
1585 # load balancer.
1586 #
1587 # If loadBalancingScheme is not specified, the backend bucket can be used by
1588 # classic global external load balancers, or global application external load
1589 # balancers, or both.
1590 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1591 # The name must be 1-63 characters long, and comply withRFC1035.
1592 # Specifically, the name must be 1-63 characters long and match the regular
1593 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1594 # character must be a lowercase letter, and all following characters must
1595 # be a dash, lowercase letter, or digit, except the last character, which
1596 # cannot be a dash.
1597 &quot;params&quot;: { # Additional Backend Bucket parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
1598 # as part of resource payload.
1599 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
1600 # Tag keys and values have the same definition as resource
1601 # manager tags. The field is allowed for INSERT
1602 # only. The keys/values to set on the resource should be specified in
1603 # either ID { : } or Namespaced format
1604 # { : }.
1605 # For example the following are valid inputs:
1606 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
1607 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
1608 # Note:
1609 # * Invalid combinations of ID &amp; namespaced format is not supported. For
1610 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
1611 &quot;a_key&quot;: &quot;A String&quot;,
1612 },
1613 },
1614 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend bucket
1615 # resides. This field is not applicable to global backend buckets.
1616 # You must specify this field as part of the HTTP request URL. It is
1617 # not settable as a field in the request body.
1618 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1619 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1620 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing that backend bucket.
1621 {
1622 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for UrlMaps referencing that
1623 # BackendBucket.
1624 },
1625 ],
1626 }</pre>
1627 </div>
1628
1629 <div class="method">
1630 <code class="details" id="getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
1631 <pre>Gets the access control policy for a resource. May be empty if no such
1632 policy or resource exists.
1633
1634 Args:
1635 project: string, Project ID for this request. (required)
1636 resource: string, Name or id of the resource for this request. (required)
1637 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
1638 x__xgafv: string, V1 error format.
1639 Allowed values
1640 1 - v1 error format
1641 2 - v2 error format
1642
1643 Returns:
1644 An object of the form:
1645
1646 { # An Identity and Access Management (IAM) policy, which specifies access
1647 # controls for Google Cloud resources.
1648 #
1649 #
1650 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
1651 # `members`, or principals, to a single `role`. Principals can be user
1652 # accounts, service accounts, Google groups, and domains (such as G Suite). A
1653 # `role` is a named list of permissions; each `role` can be an IAM predefined
1654 # role or a user-created custom role.
1655 #
1656 # For some types of Google Cloud resources, a `binding` can also specify a
1657 # `condition`, which is a logical expression that allows access to a resource
1658 # only if the expression evaluates to `true`. A condition can add constraints
1659 # based on attributes of the request, the resource, or both. To learn which
1660 # resources support conditions in their IAM policies, see the
1661 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1662 #
1663 # **JSON example:**
1664 #
1665 # ```
1666 # {
1667 # &quot;bindings&quot;: [
1668 # {
1669 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
1670 # &quot;members&quot;: [
1671 # &quot;user:[email protected]&quot;,
1672 # &quot;group:[email protected]&quot;,
1673 # &quot;domain:google.com&quot;,
1674 # &quot;serviceAccount:[email protected]&quot;
1675 # ]
1676 # },
1677 # {
1678 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
1679 # &quot;members&quot;: [
1680 # &quot;user:[email protected]&quot;
1681 # ],
1682 # &quot;condition&quot;: {
1683 # &quot;title&quot;: &quot;expirable access&quot;,
1684 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
1685 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
1686 # }
1687 # }
1688 # ],
1689 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
1690 # &quot;version&quot;: 3
1691 # }
1692 # ```
1693 #
1694 # **YAML example:**
1695 #
1696 # ```
1697 # bindings:
1698 # - members:
1699 # - user:[email protected]
1700 # - group:[email protected]
1701 # - domain:google.com
1702 # - serviceAccount:[email protected]
1703 # role: roles/resourcemanager.organizationAdmin
1704 # - members:
1705 # - user:[email protected]
1706 # role: roles/resourcemanager.organizationViewer
1707 # condition:
1708 # title: expirable access
1709 # description: Does not grant access after Sep 2020
1710 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
1711 # etag: BwWWja0YfJA=
1712 # version: 3
1713 # ```
1714 #
1715 # For a description of IAM and its features, see the
1716 # [IAM documentation](https://cloud.google.com/iam/docs/).
1717 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
1718 { # Specifies the audit configuration for a service.
1719 # The configuration determines which permission types are logged, and what
1720 # identities, if any, are exempted from logging.
1721 # An AuditConfig must have one or more AuditLogConfigs.
1722 #
1723 # If there are AuditConfigs for both `allServices` and a specific service,
1724 # the union of the two AuditConfigs is used for that service: the log_types
1725 # specified in each AuditConfig are enabled, and the exempted_members in each
1726 # AuditLogConfig are exempted.
1727 #
1728 # Example Policy with multiple AuditConfigs:
1729 #
1730 # {
1731 # &quot;audit_configs&quot;: [
1732 # {
1733 # &quot;service&quot;: &quot;allServices&quot;,
1734 # &quot;audit_log_configs&quot;: [
1735 # {
1736 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1737 # &quot;exempted_members&quot;: [
1738 # &quot;user:[email protected]&quot;
1739 # ]
1740 # },
1741 # {
1742 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1743 # },
1744 # {
1745 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
1746 # }
1747 # ]
1748 # },
1749 # {
1750 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
1751 # &quot;audit_log_configs&quot;: [
1752 # {
1753 # &quot;log_type&quot;: &quot;DATA_READ&quot;
1754 # },
1755 # {
1756 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
1757 # &quot;exempted_members&quot;: [
1758 # &quot;user:[email protected]&quot;
1759 # ]
1760 # }
1761 # ]
1762 # }
1763 # ]
1764 # }
1765 #
1766 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1767 # logging. It also exempts `[email protected]` from DATA_READ logging, and
1768 # `[email protected]` from DATA_WRITE logging.
1769 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
1770 { # Provides the configuration for logging a type of permissions.
1771 # Example:
1772 #
1773 # {
1774 # &quot;audit_log_configs&quot;: [
1775 # {
1776 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1777 # &quot;exempted_members&quot;: [
1778 # &quot;user:[email protected]&quot;
1779 # ]
1780 # },
1781 # {
1782 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1783 # }
1784 # ]
1785 # }
1786 #
1787 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
1788 # [email protected] from DATA_READ logging.
1789 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
1790 # permission.
1791 # Follows the same format of Binding.members.
1792 &quot;A String&quot;,
1793 ],
1794 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
1795 },
1796 ],
1797 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
1798 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
1799 # `allServices` is a special value that covers all services.
1800 },
1801 ],
1802 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
1803 # may specify a `condition` that determines how and when the `bindings` are
1804 # applied. Each of the `bindings` must contain at least one principal.
1805 #
1806 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
1807 # of these principals can be Google groups. Each occurrence of a principal
1808 # counts towards these limits. For example, if the `bindings` grant 50
1809 # different roles to `user:[email protected]`, and not to any other
1810 # principal, then you can add another 1,450 principals to the `bindings` in
1811 # the `Policy`.
1812 { # Associates `members`, or principals, with a `role`.
1813 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1814 #
1815 # If the condition evaluates to `true`, then this binding applies to the
1816 # current request.
1817 #
1818 # If the condition evaluates to `false`, then this binding does not apply to
1819 # the current request. However, a different role binding might grant the same
1820 # role to one or more of the principals in this binding.
1821 #
1822 # To learn which resources support conditions in their IAM policies, see the
1823 # [IAM
1824 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1825 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1826 # are documented at https://github.com/google/cel-spec.
1827 #
1828 # Example (Comparison):
1829 #
1830 # title: &quot;Summary size limit&quot;
1831 # description: &quot;Determines if a summary is less than 100 chars&quot;
1832 # expression: &quot;document.summary.size() &lt; 100&quot;
1833 #
1834 # Example (Equality):
1835 #
1836 # title: &quot;Requestor is owner&quot;
1837 # description: &quot;Determines if requestor is the document owner&quot;
1838 # expression: &quot;document.owner == request.auth.claims.email&quot;
1839 #
1840 # Example (Logic):
1841 #
1842 # title: &quot;Public documents&quot;
1843 # description: &quot;Determine whether the document should be publicly visible&quot;
1844 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
1845 #
1846 # Example (Data Manipulation):
1847 #
1848 # title: &quot;Notification string&quot;
1849 # description: &quot;Create a notification string with a timestamp.&quot;
1850 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
1851 #
1852 # The exact variables and functions that may be referenced within an expression
1853 # are determined by the service that evaluates it. See the service
1854 # documentation for additional information.
1855 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
1856 # describes the expression, e.g. when hovered over it in a UI.
1857 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
1858 # syntax.
1859 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
1860 # reporting, e.g. a file name and a position in the file.
1861 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
1862 # its purpose. This can be used e.g. in UIs which allow to enter the
1863 # expression.
1864 },
1865 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
1866 # `members` can have the following values:
1867 #
1868 # * `allUsers`: A special identifier that represents anyone who is
1869 # on the internet; with or without a Google account.
1870 #
1871 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1872 # who is authenticated with a Google account or a service account.
1873 # Does not include identities that come from external identity providers
1874 # (IdPs) through identity federation.
1875 #
1876 # * `user:{emailid}`: An email address that represents a specific Google
1877 # account. For example, `[email protected]` .
1878 #
1879 #
1880 # * `serviceAccount:{emailid}`: An email address that represents a Google
1881 # service account. For example,
1882 # `[email protected]`.
1883 #
1884 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
1885 # identifier for a
1886 # [Kubernetes service
1887 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
1888 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
1889 #
1890 # * `group:{emailid}`: An email address that represents a Google group.
1891 # For example, `[email protected]`.
1892 #
1893 #
1894 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1895 # users of that domain. For example, `google.com` or `example.com`.
1896 #
1897 #
1898 #
1899 #
1900 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1901 # A single identity in a workforce identity pool.
1902 #
1903 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
1904 # All workforce identities in a group.
1905 #
1906 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1907 # All workforce identities with a specific attribute value.
1908 #
1909 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
1910 # All identities in a workforce identity pool.
1911 #
1912 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
1913 # A single identity in a workload identity pool.
1914 #
1915 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
1916 # A workload identity pool group.
1917 #
1918 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1919 # All identities in a workload identity pool with a certain attribute.
1920 #
1921 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
1922 # All identities in a workload identity pool.
1923 #
1924 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1925 # identifier) representing a user that has been recently deleted. For
1926 # example, `[email protected]?uid=123456789012345678901`. If the user is
1927 # recovered, this value reverts to `user:{emailid}` and the recovered user
1928 # retains the role in the binding.
1929 #
1930 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1931 # unique identifier) representing a service account that has been recently
1932 # deleted. For example,
1933 # `[email protected]?uid=123456789012345678901`.
1934 # If the service account is undeleted, this value reverts to
1935 # `serviceAccount:{emailid}` and the undeleted service account retains the
1936 # role in the binding.
1937 #
1938 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1939 # identifier) representing a Google group that has been recently
1940 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
1941 # the group is recovered, this value reverts to `group:{emailid}` and the
1942 # recovered group retains the role in the binding.
1943 #
1944 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1945 # Deleted single identity in a workforce identity pool. For example,
1946 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
1947 &quot;A String&quot;,
1948 ],
1949 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
1950 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1951 #
1952 # For an overview of the IAM roles and permissions, see the
1953 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
1954 # a list of the available pre-defined roles, see
1955 # [here](https://cloud.google.com/iam/docs/understanding-roles).
1956 },
1957 ],
1958 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
1959 # prevent simultaneous updates of a policy from overwriting each other.
1960 # It is strongly suggested that systems make use of the `etag` in the
1961 # read-modify-write cycle to perform policy updates in order to avoid race
1962 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1963 # systems are expected to put that etag in the request to `setIamPolicy` to
1964 # ensure that their change will be applied to the same version of the policy.
1965 #
1966 # **Important:** If you use IAM Conditions, you must include the `etag` field
1967 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1968 # you to overwrite a version `3` policy with a version `1` policy, and all of
1969 # the conditions in the version `3` policy are lost.
1970 &quot;version&quot;: 42, # Specifies the format of the policy.
1971 #
1972 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
1973 # are rejected.
1974 #
1975 # Any operation that affects conditional role bindings must specify version
1976 # `3`. This requirement applies to the following operations:
1977 #
1978 # * Getting a policy that includes a conditional role binding
1979 # * Adding a conditional role binding to a policy
1980 # * Changing a conditional role binding in a policy
1981 # * Removing any role binding, with or without a condition, from a policy
1982 # that includes conditions
1983 #
1984 # **Important:** If you use IAM Conditions, you must include the `etag` field
1985 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1986 # you to overwrite a version `3` policy with a version `1` policy, and all of
1987 # the conditions in the version `3` policy are lost.
1988 #
1989 # If a policy does not include any conditions, operations on that policy may
1990 # specify any valid version or leave the field unset.
1991 #
1992 # To learn which resources support conditions in their IAM policies, see the
1993 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1994 }</pre>
1995 </div>
1996
1997 <div class="method">
1998 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code>
1999 <pre>Creates a BackendBucket resource in the specified project using
2000 the data included in the request.
2001
2002 Args:
2003 project: string, Project ID for this request. (required)
2004 body: object, The request body.
2005 The object takes the form of:
2006
2007 { # Represents a Cloud Storage Bucket resource.
2008 #
2009 # This Cloud Storage bucket resource is referenced by a URL map of a load
2010 # balancer. For more information, readBackend Buckets.
2011 &quot;bucketName&quot;: &quot;A String&quot;, # Cloud Storage bucket name.
2012 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket.
2013 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
2014 # Pragma or Authorization headers. Up to 5 headers can be specified.
2015 # The cache is bypassed for all cdnPolicy.cacheMode settings.
2016 { # Bypass the cache when the specified request headers are present,
2017 # e.g. Pragma or Authorization headers. Values are case insensitive.
2018 # The presence of such a header overrides the cache_mode setting.
2019 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
2020 # Values are case-insensitive.
2021 },
2022 ],
2023 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for # The CacheKeyPolicy for this CdnPolicy.
2024 # Cloud CDN.
2025 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
2026 &quot;A String&quot;,
2027 ],
2028 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. Default
2029 # parameters are always included. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded
2030 # and not treated as delimiters.
2031 &quot;A String&quot;,
2032 ],
2033 },
2034 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
2035 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
2036 # headers to cache content. Responses without these headers will not be
2037 # cached at Google&#x27;s edge, and will require a full trip to the origin on
2038 # every request, potentially impacting performance and increasing load on
2039 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
2040 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
2041 # Warning: this may result in Cloud CDN caching private,
2042 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
2043 # including common image formats, media (video and audio), and web assets
2044 # (JavaScript and CSS). Requests and responses that are marked as
2045 # uncacheable, as well as dynamic content (including HTML), will not be
2046 # cached.
2047 #
2048 # If no value is provided for cdnPolicy.cacheMode, it defaults
2049 # to CACHE_ALL_STATIC.
2050 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
2051 # used to clamp the max-age (or Expires) value sent to the client. With
2052 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
2053 # response max-age directive, along with a &quot;public&quot; directive. For
2054 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
2055 # from the origin (if specified), or else sets the response max-age
2056 # directive to the lesser of the client_ttl and default_ttl, and also
2057 # ensures a &quot;public&quot; cache-control directive is present.
2058 # If a client TTL is not specified, a default value (1 hour) will be used.
2059 # The maximum allowed value is 31,622,400s (1 year).
2060 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
2061 # responses that do not have an existing valid TTL (max-age or s-maxage).
2062 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
2063 # The value of defaultTTL cannot be set to a value greater than that of
2064 # maxTTL, but can be equal.
2065 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
2066 # will overwrite the TTL set in all responses. The maximum allowed value is
2067 # 31,622,400s (1 year), noting that infrequently accessed objects may be
2068 # evicted from the cache before the defined TTL.
2069 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
2070 # origin.
2071 # Cache directives that attempt to set a max-age or s-maxage higher than
2072 # this, or an Expires header more than maxTTL seconds in the future will
2073 # be capped at the value of maxTTL, as if it were the value of an
2074 # s-maxage Cache-Control directive.
2075 # Headers sent to the client will not be modified.
2076 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
2077 # The maximum allowed value is 31,622,400s (1 year), noting that
2078 # infrequently accessed objects may be evicted from the cache before
2079 # the defined TTL.
2080 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
2081 # to apply fine-grained caching for common errors or redirects.
2082 # This can reduce the load on your origin and improve end-user
2083 # experience by reducing response latency.
2084 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
2085 # negative caching applies to responses with the specified response code
2086 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
2087 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
2088 # to all responses with the specified response code, and override any
2089 # caching headers.
2090 # By default, Cloud CDN will apply the following default TTLs to these
2091 # status codes:
2092 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
2093 # HTTP 404 (Not Found), 410 (Gone),
2094 # 451 (Unavailable For Legal Reasons): 120s
2095 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
2096 # These defaults can be overridden in negative_caching_policy.
2097 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
2098 # negative_caching must be enabled to configure negative_caching_policy.
2099 # Omitting the policy and leaving negative_caching enabled will use
2100 # Cloud CDN&#x27;s default cache TTLs.
2101 # Note that when specifying an explicit negative_caching_policy, you
2102 # should take care to specify a cache TTL for all response codes
2103 # that you wish to cache. Cloud CDN will not apply any default
2104 # negative caching when a policy exists.
2105 { # Specify CDN TTLs for response error codes.
2106 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
2107 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
2108 # specified as values, and you cannot specify a status code more than
2109 # once.
2110 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
2111 # corresponding status code.
2112 # The maximum allowed value is 1800s (30 minutes), noting that
2113 # infrequently accessed objects may be evicted from the cache before the
2114 # defined TTL.
2115 },
2116 ],
2117 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
2118 # requests into a small number of requests to the origin.
2119 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
2120 # content with the origin, or when an error is encountered when refreshing
2121 # the cache.
2122 # This setting defines the default &quot;max-stale&quot; duration for any cached
2123 # responses that do not specify a max-stale directive. Stale responses that
2124 # exceed the TTL configured here will not be served. The default limit
2125 # (max-stale) is 86400s (1 day), which will allow stale content to be
2126 # served up to this limit beyond the max-age (or s-maxage) of a cached
2127 # response.
2128 # The maximum allowed value is 604800 (1 week).
2129 # Set this to zero (0) to disable serve-while-stale.
2130 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
2131 # considered fresh. After this time period, the response will be
2132 # revalidated before being served. Defaults to 1hr (3600s). When serving
2133 # responses to signed URL requests, Cloud CDN will internally behave as
2134 # though all responses from this backend had a &quot;Cache-Control:
2135 # public, max-age=[TTL]&quot; header, regardless of any existing
2136 # Cache-Control header. The actual headers served in responses will not be
2137 # altered.
2138 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
2139 &quot;A String&quot;,
2140 ],
2141 },
2142 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
2143 # the client&#x27;s Accept-Encoding header.
2144 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
2145 # text format.
2146 &quot;customResponseHeaders&quot;: [ # Headers that the Application Load Balancer should add to proxied responses.
2147 &quot;A String&quot;,
2148 ],
2149 &quot;description&quot;: &quot;A String&quot;, # An optional textual description of the resource; provided by the client
2150 # when the resource is created.
2151 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
2152 # this backend bucket.
2153 &quot;enableCdn&quot;: True or False, # If true, enable Cloud CDN for this BackendBucket.
2154 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
2155 &quot;kind&quot;: &quot;compute#backendBucket&quot;, # Output only. Type of the resource.
2156 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # The value can only be INTERNAL_MANAGED for cross-region internal layer 7
2157 # load balancer.
2158 #
2159 # If loadBalancingScheme is not specified, the backend bucket can be used by
2160 # classic global external load balancers, or global application external load
2161 # balancers, or both.
2162 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
2163 # The name must be 1-63 characters long, and comply withRFC1035.
2164 # Specifically, the name must be 1-63 characters long and match the regular
2165 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2166 # character must be a lowercase letter, and all following characters must
2167 # be a dash, lowercase letter, or digit, except the last character, which
2168 # cannot be a dash.
2169 &quot;params&quot;: { # Additional Backend Bucket parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
2170 # as part of resource payload.
2171 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
2172 # Tag keys and values have the same definition as resource
2173 # manager tags. The field is allowed for INSERT
2174 # only. The keys/values to set on the resource should be specified in
2175 # either ID { : } or Namespaced format
2176 # { : }.
2177 # For example the following are valid inputs:
2178 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
2179 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
2180 # Note:
2181 # * Invalid combinations of ID &amp; namespaced format is not supported. For
2182 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
2183 &quot;a_key&quot;: &quot;A String&quot;,
2184 },
2185 },
2186 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend bucket
2187 # resides. This field is not applicable to global backend buckets.
2188 # You must specify this field as part of the HTTP request URL. It is
2189 # not settable as a field in the request body.
2190 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2191 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2192 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing that backend bucket.
2193 {
2194 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for UrlMaps referencing that
2195 # BackendBucket.
2196 },
2197 ],
2198 }
2199
2200 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2201 that if you must retry your request, the server will know to ignore the
2202 request if it has already been completed.
2203
2204 For example, consider a situation where you make an initial request and
2205 the request times out. If you make the request again with the same
2206 request ID, the server can check if original operation with the same
2207 request ID was received, and if so, will ignore the second request. This
2208 prevents clients from accidentally creating duplicate commitments.
2209
2210 The request ID must be
2211 a valid UUID with the exception that zero UUID is not supported
2212 (00000000-0000-0000-0000-000000000000).
2213 x__xgafv: string, V1 error format.
2214 Allowed values
2215 1 - v1 error format
2216 2 - v2 error format
2217
2218 Returns:
2219 An object of the form:
2220
2221 { # Represents an Operation resource.
2222 #
2223 # Google Compute Engine has three Operation resources:
2224 #
2225 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
2226 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
2227 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
2228 #
2229 # You can use an operation resource to manage asynchronous API requests.
2230 # For more information, readHandling
2231 # API responses.
2232 #
2233 # Operations can be global, regional or zonal.
2234 #
2235 # - For global operations, use the `globalOperations`
2236 # resource.
2237 # - For regional operations, use the
2238 # `regionOperations` resource.
2239 # - For zonal operations, use
2240 # the `zoneOperations` resource.
2241 #
2242 #
2243 #
2244 # For more information, read
2245 # Global, Regional, and Zonal Resources.
2246 #
2247 # Note that completed Operation resources have a limited
2248 # retention period.
2249 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2250 # Not present otherwise.
2251 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2252 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2253 # set when the operation is created.
2254 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2255 # text format.
2256 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2257 # this field will be populated.
2258 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2259 # operation.
2260 {
2261 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2262 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2263 # details. There is a set of defined message types to use for providing
2264 # details.The syntax depends on the error code. For example,
2265 # QuotaExceededInfo will have details when the error code is
2266 # QUOTA_EXCEEDED.
2267 {
2268 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2269 #
2270 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2271 # is not enabled:
2272 #
2273 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2274 # &quot;domain&quot;: &quot;googleapis.com&quot;
2275 # &quot;metadata&quot;: {
2276 # &quot;resource&quot;: &quot;projects/123&quot;,
2277 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2278 # }
2279 # }
2280 #
2281 # This response indicates that the pubsub.googleapis.com API is not enabled.
2282 #
2283 # Example of an error that is returned when attempting to create a Spanner
2284 # instance in a region that is out of stock:
2285 #
2286 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2287 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2288 # &quot;metadata&quot;: {
2289 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2290 # }
2291 # }
2292 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2293 # is typically the registered service name of the tool or product that
2294 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2295 # generated by some common infrastructure, the error domain must be a
2296 # globally unique value that identifies the infrastructure. For Google API
2297 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2298 &quot;metadatas&quot;: { # Additional structured details about this error.
2299 #
2300 # Keys must match a regular expression of `a-z+` but should
2301 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2302 # length. When identifying the current value of an exceeded limit, the units
2303 # should be contained in the key, not the value. For example, rather than
2304 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2305 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2306 # instances that can be created in a single (batch) request.
2307 &quot;a_key&quot;: &quot;A String&quot;,
2308 },
2309 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2310 # proximate cause of the error. Error reasons are unique within a particular
2311 # domain of errors. This should be at most 63 characters and match a
2312 # regular expression of `A-Z+[A-Z0-9]`, which represents
2313 # UPPER_SNAKE_CASE.
2314 },
2315 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2316 #
2317 # For example, if a quota check failed with an error indicating the calling
2318 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2319 # directly to the right place in the developer console to flip the bit.
2320 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2321 { # Describes a URL link.
2322 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2323 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2324 },
2325 ],
2326 },
2327 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2328 # which can be attached to an RPC error.
2329 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2330 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2331 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2332 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2333 },
2334 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2335 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2336 &quot;a_key&quot;: &quot;A String&quot;,
2337 },
2338 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2339 # type or metric.
2340 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2341 # or metric.
2342 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2343 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2344 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2345 },
2346 },
2347 ],
2348 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2349 # This property is optional.
2350 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2351 },
2352 ],
2353 },
2354 &quot;getVersionOperationMetadata&quot;: {
2355 &quot;inlineSbomInfo&quot;: {
2356 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2357 # appropriate identifiers.
2358 &quot;a_key&quot;: &quot;A String&quot;,
2359 },
2360 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2361 # identifiers.
2362 &quot;a_key&quot;: &quot;A String&quot;,
2363 },
2364 },
2365 },
2366 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2367 # message that was returned, such as `NOT FOUND`.
2368 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2369 # status code that was returned. For example, a `404` means the
2370 # resource was not found.
2371 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2372 # defined by the server.
2373 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2374 # This value is inRFC3339
2375 # text format.
2376 &quot;instancesBulkInsertOperationMetadata&quot;: {
2377 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2378 # Example key: zones/us-central1-a
2379 &quot;a_key&quot;: {
2380 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2381 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2382 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2383 # error.
2384 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2385 # if the flow is rolling forward or rolling back.
2386 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2387 },
2388 },
2389 },
2390 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2391 # Operation resources.
2392 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2393 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2394 # group of operations results from a `bulkInsert` API request.
2395 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2396 # `update`, or `delete`, and so on.
2397 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2398 # There is no requirement that this be linear or support any granularity of
2399 # operations. This should not be used to guess when the operation will be
2400 # complete. This number should monotonically increase as the operation
2401 # progresses.
2402 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2403 # applicable when performing regional operations.
2404 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2405 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2406 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2407 # this field will contain information on all underlying zonal actions and
2408 # their state.
2409 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2410 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2411 # Example key: zones/us-central1-a
2412 &quot;a_key&quot;: {
2413 &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
2414 # populated.
2415 # different programming environments, including REST APIs and RPC APIs. It is
2416 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2417 # three pieces of data: error code, error message, and error details.
2418 #
2419 # You can find out more about this error model and how to work with it in the
2420 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2421 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2422 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2423 # message types for APIs to use.
2424 {
2425 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2426 },
2427 ],
2428 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2429 # user-facing error message should be localized and sent in the
2430 # google.rpc.Status.details field, or localized by the client.
2431 },
2432 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2433 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2434 },
2435 },
2436 },
2437 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2438 # This value is inRFC3339
2439 # text format.
2440 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2441 # following:
2442 # `PENDING`, `RUNNING`, or `DONE`.
2443 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2444 # operation.
2445 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2446 # of the target resource.
2447 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2448 # operations related to creating a snapshot, this points to the disk
2449 # that the snapshot was created from.
2450 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2451 # `[email protected]` or
2452 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2453 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2454 # operation, this field will be populated.
2455 {
2456 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2457 # Engine returns NO_RESULTS_ON_PAGE if there
2458 # are no results in the response.
2459 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2460 # value format. For example:
2461 #
2462 # &quot;data&quot;: [
2463 # {
2464 # &quot;key&quot;: &quot;scope&quot;,
2465 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2466 # }
2467 {
2468 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2469 # returned. For example, for warnings where there are no results in a list
2470 # request for a particular zone, this key might be scope and
2471 # the key value might be the zone name. Other examples might be a key
2472 # indicating a deprecated resource and a suggested replacement, or a
2473 # warning about invalid network settings (for example, if an instance
2474 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2475 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2476 },
2477 ],
2478 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2479 },
2480 ],
2481 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2482 # applicable when performing per-zone operations.
2483 }</pre>
2484 </div>
2485
2486 <div class="method">
2487 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
2488 <pre>Retrieves the list of BackendBucket resources available to the specified
2489 project.
2490
2491 Args:
2492 project: string, Project ID for this request. (required)
2493 filter: string, A filter expression that filters resources listed in the response. Most
2494 Compute resources support two types of filter expressions:
2495 expressions that support regular expressions and expressions that follow
2496 API improvement proposal AIP-160.
2497 These two types of filter expressions cannot be mixed in one request.
2498
2499 If you want to use AIP-160, your expression must specify the field name, an
2500 operator, and the value that you want to use for filtering. The value
2501 must be a string, a number, or a boolean. The operator
2502 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
2503
2504 For example, if you are filtering Compute Engine instances, you can
2505 exclude instances named `example-instance` by specifying
2506 `name != example-instance`.
2507
2508 The `:*` comparison can be used to test whether a key has been defined.
2509 For example, to find all objects with `owner` label use:
2510 ```
2511 labels.owner:*
2512 ```
2513
2514 You can also filter nested fields. For example, you could specify
2515 `scheduling.automaticRestart = false` to include instances only
2516 if they are not scheduled for automatic restarts. You can use filtering
2517 on nested fields to filter based onresource labels.
2518
2519 To filter on multiple expressions, provide each separate expression within
2520 parentheses. For example:
2521 ```
2522 (scheduling.automaticRestart = true)
2523 (cpuPlatform = &quot;Intel Skylake&quot;)
2524 ```
2525 By default, each expression is an `AND` expression. However, you
2526 can include `AND` and `OR` expressions explicitly.
2527 For example:
2528 ```
2529 (cpuPlatform = &quot;Intel Skylake&quot;) OR
2530 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
2531 (scheduling.automaticRestart = true)
2532 ```
2533
2534 If you want to use a regular expression, use the `eq` (equal) or `ne`
2535 (not equal) operator against a single un-parenthesized expression with or
2536 without quotes or against multiple parenthesized expressions. Examples:
2537
2538 `fieldname eq unquoted literal`
2539 `fieldname eq &#x27;single quoted literal&#x27;`
2540 `fieldname eq &quot;double quoted literal&quot;`
2541 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
2542
2543 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
2544 The literal value must match the entire field.
2545
2546 For example, to filter for instances that do not end with name &quot;instance&quot;,
2547 you would use `name ne .*instance`.
2548
2549 You cannot combine constraints on multiple fields using regular
2550 expressions.
2551 maxResults: integer, The maximum number of results per page that should be returned.
2552 If the number of available results is larger than `maxResults`,
2553 Compute Engine returns a `nextPageToken` that can be used to get
2554 the next page of results in subsequent list requests. Acceptable values are
2555 `0` to `500`, inclusive. (Default: `500`)
2556 orderBy: string, Sorts list results by a certain order. By default, results
2557 are returned in alphanumerical order based on the resource name.
2558
2559 You can also sort results in descending order based on the creation
2560 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
2561 results based on the `creationTimestamp` field in
2562 reverse chronological order (newest result first). Use this to sort
2563 resources like operations so that the newest operation is returned first.
2564
2565 Currently, only sorting by `name` or
2566 `creationTimestamp desc` is supported.
2567 pageToken: string, Specifies a page token to use. Set `pageToken` to the
2568 `nextPageToken` returned by a previous list request to get
2569 the next page of results.
2570 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
2571 of failure. The default value is false.
2572
2573 For example, when partial success behavior is enabled, aggregatedList for a
2574 single zone scope either returns all resources in the zone or no resources,
2575 with an error code.
2576 x__xgafv: string, V1 error format.
2577 Allowed values
2578 1 - v1 error format
2579 2 - v2 error format
2580
2581 Returns:
2582 An object of the form:
2583
2584 { # Contains a list of BackendBucket resources.
2585 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
2586 &quot;items&quot;: [ # A list of BackendBucket resources.
2587 { # Represents a Cloud Storage Bucket resource.
2588 #
2589 # This Cloud Storage bucket resource is referenced by a URL map of a load
2590 # balancer. For more information, readBackend Buckets.
2591 &quot;bucketName&quot;: &quot;A String&quot;, # Cloud Storage bucket name.
2592 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket.
2593 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
2594 # Pragma or Authorization headers. Up to 5 headers can be specified.
2595 # The cache is bypassed for all cdnPolicy.cacheMode settings.
2596 { # Bypass the cache when the specified request headers are present,
2597 # e.g. Pragma or Authorization headers. Values are case insensitive.
2598 # The presence of such a header overrides the cache_mode setting.
2599 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
2600 # Values are case-insensitive.
2601 },
2602 ],
2603 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for # The CacheKeyPolicy for this CdnPolicy.
2604 # Cloud CDN.
2605 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
2606 &quot;A String&quot;,
2607 ],
2608 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. Default
2609 # parameters are always included. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded
2610 # and not treated as delimiters.
2611 &quot;A String&quot;,
2612 ],
2613 },
2614 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
2615 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
2616 # headers to cache content. Responses without these headers will not be
2617 # cached at Google&#x27;s edge, and will require a full trip to the origin on
2618 # every request, potentially impacting performance and increasing load on
2619 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
2620 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
2621 # Warning: this may result in Cloud CDN caching private,
2622 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
2623 # including common image formats, media (video and audio), and web assets
2624 # (JavaScript and CSS). Requests and responses that are marked as
2625 # uncacheable, as well as dynamic content (including HTML), will not be
2626 # cached.
2627 #
2628 # If no value is provided for cdnPolicy.cacheMode, it defaults
2629 # to CACHE_ALL_STATIC.
2630 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
2631 # used to clamp the max-age (or Expires) value sent to the client. With
2632 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
2633 # response max-age directive, along with a &quot;public&quot; directive. For
2634 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
2635 # from the origin (if specified), or else sets the response max-age
2636 # directive to the lesser of the client_ttl and default_ttl, and also
2637 # ensures a &quot;public&quot; cache-control directive is present.
2638 # If a client TTL is not specified, a default value (1 hour) will be used.
2639 # The maximum allowed value is 31,622,400s (1 year).
2640 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
2641 # responses that do not have an existing valid TTL (max-age or s-maxage).
2642 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
2643 # The value of defaultTTL cannot be set to a value greater than that of
2644 # maxTTL, but can be equal.
2645 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
2646 # will overwrite the TTL set in all responses. The maximum allowed value is
2647 # 31,622,400s (1 year), noting that infrequently accessed objects may be
2648 # evicted from the cache before the defined TTL.
2649 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
2650 # origin.
2651 # Cache directives that attempt to set a max-age or s-maxage higher than
2652 # this, or an Expires header more than maxTTL seconds in the future will
2653 # be capped at the value of maxTTL, as if it were the value of an
2654 # s-maxage Cache-Control directive.
2655 # Headers sent to the client will not be modified.
2656 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
2657 # The maximum allowed value is 31,622,400s (1 year), noting that
2658 # infrequently accessed objects may be evicted from the cache before
2659 # the defined TTL.
2660 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
2661 # to apply fine-grained caching for common errors or redirects.
2662 # This can reduce the load on your origin and improve end-user
2663 # experience by reducing response latency.
2664 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
2665 # negative caching applies to responses with the specified response code
2666 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
2667 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
2668 # to all responses with the specified response code, and override any
2669 # caching headers.
2670 # By default, Cloud CDN will apply the following default TTLs to these
2671 # status codes:
2672 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
2673 # HTTP 404 (Not Found), 410 (Gone),
2674 # 451 (Unavailable For Legal Reasons): 120s
2675 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
2676 # These defaults can be overridden in negative_caching_policy.
2677 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
2678 # negative_caching must be enabled to configure negative_caching_policy.
2679 # Omitting the policy and leaving negative_caching enabled will use
2680 # Cloud CDN&#x27;s default cache TTLs.
2681 # Note that when specifying an explicit negative_caching_policy, you
2682 # should take care to specify a cache TTL for all response codes
2683 # that you wish to cache. Cloud CDN will not apply any default
2684 # negative caching when a policy exists.
2685 { # Specify CDN TTLs for response error codes.
2686 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
2687 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
2688 # specified as values, and you cannot specify a status code more than
2689 # once.
2690 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
2691 # corresponding status code.
2692 # The maximum allowed value is 1800s (30 minutes), noting that
2693 # infrequently accessed objects may be evicted from the cache before the
2694 # defined TTL.
2695 },
2696 ],
2697 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
2698 # requests into a small number of requests to the origin.
2699 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
2700 # content with the origin, or when an error is encountered when refreshing
2701 # the cache.
2702 # This setting defines the default &quot;max-stale&quot; duration for any cached
2703 # responses that do not specify a max-stale directive. Stale responses that
2704 # exceed the TTL configured here will not be served. The default limit
2705 # (max-stale) is 86400s (1 day), which will allow stale content to be
2706 # served up to this limit beyond the max-age (or s-maxage) of a cached
2707 # response.
2708 # The maximum allowed value is 604800 (1 week).
2709 # Set this to zero (0) to disable serve-while-stale.
2710 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
2711 # considered fresh. After this time period, the response will be
2712 # revalidated before being served. Defaults to 1hr (3600s). When serving
2713 # responses to signed URL requests, Cloud CDN will internally behave as
2714 # though all responses from this backend had a &quot;Cache-Control:
2715 # public, max-age=[TTL]&quot; header, regardless of any existing
2716 # Cache-Control header. The actual headers served in responses will not be
2717 # altered.
2718 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
2719 &quot;A String&quot;,
2720 ],
2721 },
2722 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
2723 # the client&#x27;s Accept-Encoding header.
2724 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
2725 # text format.
2726 &quot;customResponseHeaders&quot;: [ # Headers that the Application Load Balancer should add to proxied responses.
2727 &quot;A String&quot;,
2728 ],
2729 &quot;description&quot;: &quot;A String&quot;, # An optional textual description of the resource; provided by the client
2730 # when the resource is created.
2731 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
2732 # this backend bucket.
2733 &quot;enableCdn&quot;: True or False, # If true, enable Cloud CDN for this BackendBucket.
2734 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
2735 &quot;kind&quot;: &quot;compute#backendBucket&quot;, # Output only. Type of the resource.
2736 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # The value can only be INTERNAL_MANAGED for cross-region internal layer 7
2737 # load balancer.
2738 #
2739 # If loadBalancingScheme is not specified, the backend bucket can be used by
2740 # classic global external load balancers, or global application external load
2741 # balancers, or both.
2742 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
2743 # The name must be 1-63 characters long, and comply withRFC1035.
2744 # Specifically, the name must be 1-63 characters long and match the regular
2745 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2746 # character must be a lowercase letter, and all following characters must
2747 # be a dash, lowercase letter, or digit, except the last character, which
2748 # cannot be a dash.
2749 &quot;params&quot;: { # Additional Backend Bucket parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
2750 # as part of resource payload.
2751 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
2752 # Tag keys and values have the same definition as resource
2753 # manager tags. The field is allowed for INSERT
2754 # only. The keys/values to set on the resource should be specified in
2755 # either ID { : } or Namespaced format
2756 # { : }.
2757 # For example the following are valid inputs:
2758 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
2759 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
2760 # Note:
2761 # * Invalid combinations of ID &amp; namespaced format is not supported. For
2762 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
2763 &quot;a_key&quot;: &quot;A String&quot;,
2764 },
2765 },
2766 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend bucket
2767 # resides. This field is not applicable to global backend buckets.
2768 # You must specify this field as part of the HTTP request URL. It is
2769 # not settable as a field in the request body.
2770 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2771 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2772 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing that backend bucket.
2773 {
2774 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for UrlMaps referencing that
2775 # BackendBucket.
2776 },
2777 ],
2778 },
2779 ],
2780 &quot;kind&quot;: &quot;compute#backendBucketList&quot;, # Output only. Type of resource.
2781 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
2782 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
2783 # the query parameter pageToken in the next list request.
2784 # Subsequent list requests will have their own nextPageToken to
2785 # continue paging through the results.
2786 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
2787 &quot;warning&quot;: { # [Output Only] Informational warning message.
2788 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2789 # Engine returns NO_RESULTS_ON_PAGE if there
2790 # are no results in the response.
2791 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2792 # value format. For example:
2793 #
2794 # &quot;data&quot;: [
2795 # {
2796 # &quot;key&quot;: &quot;scope&quot;,
2797 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2798 # }
2799 {
2800 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2801 # returned. For example, for warnings where there are no results in a list
2802 # request for a particular zone, this key might be scope and
2803 # the key value might be the zone name. Other examples might be a key
2804 # indicating a deprecated resource and a suggested replacement, or a
2805 # warning about invalid network settings (for example, if an instance
2806 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2807 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2808 },
2809 ],
2810 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2811 },
2812 }</pre>
2813 </div>
2814
2815 <div class="method">
2816 <code class="details" id="listUsable">listUsable(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
2817 <pre>Retrieves a list of all usable backend buckets in the specified project.
2818
2819 Args:
2820 project: string, Project ID for this request. (required)
2821 filter: string, A filter expression that filters resources listed in the response. Most
2822 Compute resources support two types of filter expressions:
2823 expressions that support regular expressions and expressions that follow
2824 API improvement proposal AIP-160.
2825 These two types of filter expressions cannot be mixed in one request.
2826
2827 If you want to use AIP-160, your expression must specify the field name, an
2828 operator, and the value that you want to use for filtering. The value
2829 must be a string, a number, or a boolean. The operator
2830 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
2831
2832 For example, if you are filtering Compute Engine instances, you can
2833 exclude instances named `example-instance` by specifying
2834 `name != example-instance`.
2835
2836 The `:*` comparison can be used to test whether a key has been defined.
2837 For example, to find all objects with `owner` label use:
2838 ```
2839 labels.owner:*
2840 ```
2841
2842 You can also filter nested fields. For example, you could specify
2843 `scheduling.automaticRestart = false` to include instances only
2844 if they are not scheduled for automatic restarts. You can use filtering
2845 on nested fields to filter based onresource labels.
2846
2847 To filter on multiple expressions, provide each separate expression within
2848 parentheses. For example:
2849 ```
2850 (scheduling.automaticRestart = true)
2851 (cpuPlatform = &quot;Intel Skylake&quot;)
2852 ```
2853 By default, each expression is an `AND` expression. However, you
2854 can include `AND` and `OR` expressions explicitly.
2855 For example:
2856 ```
2857 (cpuPlatform = &quot;Intel Skylake&quot;) OR
2858 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
2859 (scheduling.automaticRestart = true)
2860 ```
2861
2862 If you want to use a regular expression, use the `eq` (equal) or `ne`
2863 (not equal) operator against a single un-parenthesized expression with or
2864 without quotes or against multiple parenthesized expressions. Examples:
2865
2866 `fieldname eq unquoted literal`
2867 `fieldname eq &#x27;single quoted literal&#x27;`
2868 `fieldname eq &quot;double quoted literal&quot;`
2869 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
2870
2871 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
2872 The literal value must match the entire field.
2873
2874 For example, to filter for instances that do not end with name &quot;instance&quot;,
2875 you would use `name ne .*instance`.
2876
2877 You cannot combine constraints on multiple fields using regular
2878 expressions.
2879 maxResults: integer, The maximum number of results per page that should be returned.
2880 If the number of available results is larger than `maxResults`,
2881 Compute Engine returns a `nextPageToken` that can be used to get
2882 the next page of results in subsequent list requests. Acceptable values are
2883 `0` to `500`, inclusive. (Default: `500`)
2884 orderBy: string, Sorts list results by a certain order. By default, results
2885 are returned in alphanumerical order based on the resource name.
2886
2887 You can also sort results in descending order based on the creation
2888 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
2889 results based on the `creationTimestamp` field in
2890 reverse chronological order (newest result first). Use this to sort
2891 resources like operations so that the newest operation is returned first.
2892
2893 Currently, only sorting by `name` or
2894 `creationTimestamp desc` is supported.
2895 pageToken: string, Specifies a page token to use. Set `pageToken` to the
2896 `nextPageToken` returned by a previous list request to get
2897 the next page of results.
2898 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
2899 of failure. The default value is false.
2900
2901 For example, when partial success behavior is enabled, aggregatedList for a
2902 single zone scope either returns all resources in the zone or no resources,
2903 with an error code.
2904 x__xgafv: string, V1 error format.
2905 Allowed values
2906 1 - v1 error format
2907 2 - v2 error format
2908
2909 Returns:
2910 An object of the form:
2911
2912 {
2913 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
2914 &quot;items&quot;: [ # A list of BackendBucket resources.
2915 { # Represents a Cloud Storage Bucket resource.
2916 #
2917 # This Cloud Storage bucket resource is referenced by a URL map of a load
2918 # balancer. For more information, readBackend Buckets.
2919 &quot;bucketName&quot;: &quot;A String&quot;, # Cloud Storage bucket name.
2920 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket.
2921 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
2922 # Pragma or Authorization headers. Up to 5 headers can be specified.
2923 # The cache is bypassed for all cdnPolicy.cacheMode settings.
2924 { # Bypass the cache when the specified request headers are present,
2925 # e.g. Pragma or Authorization headers. Values are case insensitive.
2926 # The presence of such a header overrides the cache_mode setting.
2927 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
2928 # Values are case-insensitive.
2929 },
2930 ],
2931 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for # The CacheKeyPolicy for this CdnPolicy.
2932 # Cloud CDN.
2933 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
2934 &quot;A String&quot;,
2935 ],
2936 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. Default
2937 # parameters are always included. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded
2938 # and not treated as delimiters.
2939 &quot;A String&quot;,
2940 ],
2941 },
2942 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
2943 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
2944 # headers to cache content. Responses without these headers will not be
2945 # cached at Google&#x27;s edge, and will require a full trip to the origin on
2946 # every request, potentially impacting performance and increasing load on
2947 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
2948 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
2949 # Warning: this may result in Cloud CDN caching private,
2950 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
2951 # including common image formats, media (video and audio), and web assets
2952 # (JavaScript and CSS). Requests and responses that are marked as
2953 # uncacheable, as well as dynamic content (including HTML), will not be
2954 # cached.
2955 #
2956 # If no value is provided for cdnPolicy.cacheMode, it defaults
2957 # to CACHE_ALL_STATIC.
2958 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
2959 # used to clamp the max-age (or Expires) value sent to the client. With
2960 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
2961 # response max-age directive, along with a &quot;public&quot; directive. For
2962 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
2963 # from the origin (if specified), or else sets the response max-age
2964 # directive to the lesser of the client_ttl and default_ttl, and also
2965 # ensures a &quot;public&quot; cache-control directive is present.
2966 # If a client TTL is not specified, a default value (1 hour) will be used.
2967 # The maximum allowed value is 31,622,400s (1 year).
2968 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
2969 # responses that do not have an existing valid TTL (max-age or s-maxage).
2970 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
2971 # The value of defaultTTL cannot be set to a value greater than that of
2972 # maxTTL, but can be equal.
2973 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
2974 # will overwrite the TTL set in all responses. The maximum allowed value is
2975 # 31,622,400s (1 year), noting that infrequently accessed objects may be
2976 # evicted from the cache before the defined TTL.
2977 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
2978 # origin.
2979 # Cache directives that attempt to set a max-age or s-maxage higher than
2980 # this, or an Expires header more than maxTTL seconds in the future will
2981 # be capped at the value of maxTTL, as if it were the value of an
2982 # s-maxage Cache-Control directive.
2983 # Headers sent to the client will not be modified.
2984 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
2985 # The maximum allowed value is 31,622,400s (1 year), noting that
2986 # infrequently accessed objects may be evicted from the cache before
2987 # the defined TTL.
2988 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
2989 # to apply fine-grained caching for common errors or redirects.
2990 # This can reduce the load on your origin and improve end-user
2991 # experience by reducing response latency.
2992 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
2993 # negative caching applies to responses with the specified response code
2994 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
2995 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
2996 # to all responses with the specified response code, and override any
2997 # caching headers.
2998 # By default, Cloud CDN will apply the following default TTLs to these
2999 # status codes:
3000 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
3001 # HTTP 404 (Not Found), 410 (Gone),
3002 # 451 (Unavailable For Legal Reasons): 120s
3003 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
3004 # These defaults can be overridden in negative_caching_policy.
3005 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
3006 # negative_caching must be enabled to configure negative_caching_policy.
3007 # Omitting the policy and leaving negative_caching enabled will use
3008 # Cloud CDN&#x27;s default cache TTLs.
3009 # Note that when specifying an explicit negative_caching_policy, you
3010 # should take care to specify a cache TTL for all response codes
3011 # that you wish to cache. Cloud CDN will not apply any default
3012 # negative caching when a policy exists.
3013 { # Specify CDN TTLs for response error codes.
3014 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
3015 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
3016 # specified as values, and you cannot specify a status code more than
3017 # once.
3018 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
3019 # corresponding status code.
3020 # The maximum allowed value is 1800s (30 minutes), noting that
3021 # infrequently accessed objects may be evicted from the cache before the
3022 # defined TTL.
3023 },
3024 ],
3025 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
3026 # requests into a small number of requests to the origin.
3027 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
3028 # content with the origin, or when an error is encountered when refreshing
3029 # the cache.
3030 # This setting defines the default &quot;max-stale&quot; duration for any cached
3031 # responses that do not specify a max-stale directive. Stale responses that
3032 # exceed the TTL configured here will not be served. The default limit
3033 # (max-stale) is 86400s (1 day), which will allow stale content to be
3034 # served up to this limit beyond the max-age (or s-maxage) of a cached
3035 # response.
3036 # The maximum allowed value is 604800 (1 week).
3037 # Set this to zero (0) to disable serve-while-stale.
3038 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
3039 # considered fresh. After this time period, the response will be
3040 # revalidated before being served. Defaults to 1hr (3600s). When serving
3041 # responses to signed URL requests, Cloud CDN will internally behave as
3042 # though all responses from this backend had a &quot;Cache-Control:
3043 # public, max-age=[TTL]&quot; header, regardless of any existing
3044 # Cache-Control header. The actual headers served in responses will not be
3045 # altered.
3046 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
3047 &quot;A String&quot;,
3048 ],
3049 },
3050 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
3051 # the client&#x27;s Accept-Encoding header.
3052 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
3053 # text format.
3054 &quot;customResponseHeaders&quot;: [ # Headers that the Application Load Balancer should add to proxied responses.
3055 &quot;A String&quot;,
3056 ],
3057 &quot;description&quot;: &quot;A String&quot;, # An optional textual description of the resource; provided by the client
3058 # when the resource is created.
3059 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
3060 # this backend bucket.
3061 &quot;enableCdn&quot;: True or False, # If true, enable Cloud CDN for this BackendBucket.
3062 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
3063 &quot;kind&quot;: &quot;compute#backendBucket&quot;, # Output only. Type of the resource.
3064 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # The value can only be INTERNAL_MANAGED for cross-region internal layer 7
3065 # load balancer.
3066 #
3067 # If loadBalancingScheme is not specified, the backend bucket can be used by
3068 # classic global external load balancers, or global application external load
3069 # balancers, or both.
3070 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
3071 # The name must be 1-63 characters long, and comply withRFC1035.
3072 # Specifically, the name must be 1-63 characters long and match the regular
3073 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
3074 # character must be a lowercase letter, and all following characters must
3075 # be a dash, lowercase letter, or digit, except the last character, which
3076 # cannot be a dash.
3077 &quot;params&quot;: { # Additional Backend Bucket parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
3078 # as part of resource payload.
3079 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
3080 # Tag keys and values have the same definition as resource
3081 # manager tags. The field is allowed for INSERT
3082 # only. The keys/values to set on the resource should be specified in
3083 # either ID { : } or Namespaced format
3084 # { : }.
3085 # For example the following are valid inputs:
3086 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
3087 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
3088 # Note:
3089 # * Invalid combinations of ID &amp; namespaced format is not supported. For
3090 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
3091 &quot;a_key&quot;: &quot;A String&quot;,
3092 },
3093 },
3094 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend bucket
3095 # resides. This field is not applicable to global backend buckets.
3096 # You must specify this field as part of the HTTP request URL. It is
3097 # not settable as a field in the request body.
3098 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3099 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
3100 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing that backend bucket.
3101 {
3102 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for UrlMaps referencing that
3103 # BackendBucket.
3104 },
3105 ],
3106 },
3107 ],
3108 &quot;kind&quot;: &quot;compute#usableBackendBucketList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#usableBackendBucketList for lists of usable backend
3109 # buckets.
3110 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
3111 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
3112 # the query parameter pageToken in the next list request.
3113 # Subsequent list requests will have their own nextPageToken to
3114 # continue paging through the results.
3115 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
3116 &quot;warning&quot;: { # [Output Only] Informational warning message.
3117 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3118 # Engine returns NO_RESULTS_ON_PAGE if there
3119 # are no results in the response.
3120 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3121 # value format. For example:
3122 #
3123 # &quot;data&quot;: [
3124 # {
3125 # &quot;key&quot;: &quot;scope&quot;,
3126 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3127 # }
3128 {
3129 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3130 # returned. For example, for warnings where there are no results in a list
3131 # request for a particular zone, this key might be scope and
3132 # the key value might be the zone name. Other examples might be a key
3133 # indicating a deprecated resource and a suggested replacement, or a
3134 # warning about invalid network settings (for example, if an instance
3135 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3136 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3137 },
3138 ],
3139 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3140 },
3141 }</pre>
3142 </div>
3143
3144 <div class="method">
3145 <code class="details" id="listUsable_next">listUsable_next()</code>
3146 <pre>Retrieves the next page of results.
3147
3148 Args:
3149 previous_request: The request for the previous page. (required)
3150 previous_response: The response from the request for the previous page. (required)
3151
3152 Returns:
3153 A request object that you can call &#x27;execute()&#x27; on to request the next
3154 page. Returns None if there are no more items in the collection.
3155 </pre>
3156 </div>
3157
3158 <div class="method">
3159 <code class="details" id="list_next">list_next()</code>
3160 <pre>Retrieves the next page of results.
3161
3162 Args:
3163 previous_request: The request for the previous page. (required)
3164 previous_response: The response from the request for the previous page. (required)
3165
3166 Returns:
3167 A request object that you can call &#x27;execute()&#x27; on to request the next
3168 page. Returns None if there are no more items in the collection.
3169 </pre>
3170 </div>
3171
3172 <div class="method">
3173 <code class="details" id="patch">patch(project, backendBucket, body=None, requestId=None, x__xgafv=None)</code>
3174 <pre>Updates the specified BackendBucket resource with the data included in the
3175 request. This method supportsPATCH
3176 semantics and uses theJSON merge
3177 patch format and processing rules.
3178
3179 Args:
3180 project: string, Project ID for this request. (required)
3181 backendBucket: string, Name of the BackendBucket resource to patch. (required)
3182 body: object, The request body.
3183 The object takes the form of:
3184
3185 { # Represents a Cloud Storage Bucket resource.
3186 #
3187 # This Cloud Storage bucket resource is referenced by a URL map of a load
3188 # balancer. For more information, readBackend Buckets.
3189 &quot;bucketName&quot;: &quot;A String&quot;, # Cloud Storage bucket name.
3190 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket.
3191 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
3192 # Pragma or Authorization headers. Up to 5 headers can be specified.
3193 # The cache is bypassed for all cdnPolicy.cacheMode settings.
3194 { # Bypass the cache when the specified request headers are present,
3195 # e.g. Pragma or Authorization headers. Values are case insensitive.
3196 # The presence of such a header overrides the cache_mode setting.
3197 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
3198 # Values are case-insensitive.
3199 },
3200 ],
3201 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for # The CacheKeyPolicy for this CdnPolicy.
3202 # Cloud CDN.
3203 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
3204 &quot;A String&quot;,
3205 ],
3206 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. Default
3207 # parameters are always included. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded
3208 # and not treated as delimiters.
3209 &quot;A String&quot;,
3210 ],
3211 },
3212 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
3213 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
3214 # headers to cache content. Responses without these headers will not be
3215 # cached at Google&#x27;s edge, and will require a full trip to the origin on
3216 # every request, potentially impacting performance and increasing load on
3217 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
3218 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
3219 # Warning: this may result in Cloud CDN caching private,
3220 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
3221 # including common image formats, media (video and audio), and web assets
3222 # (JavaScript and CSS). Requests and responses that are marked as
3223 # uncacheable, as well as dynamic content (including HTML), will not be
3224 # cached.
3225 #
3226 # If no value is provided for cdnPolicy.cacheMode, it defaults
3227 # to CACHE_ALL_STATIC.
3228 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
3229 # used to clamp the max-age (or Expires) value sent to the client. With
3230 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
3231 # response max-age directive, along with a &quot;public&quot; directive. For
3232 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
3233 # from the origin (if specified), or else sets the response max-age
3234 # directive to the lesser of the client_ttl and default_ttl, and also
3235 # ensures a &quot;public&quot; cache-control directive is present.
3236 # If a client TTL is not specified, a default value (1 hour) will be used.
3237 # The maximum allowed value is 31,622,400s (1 year).
3238 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
3239 # responses that do not have an existing valid TTL (max-age or s-maxage).
3240 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
3241 # The value of defaultTTL cannot be set to a value greater than that of
3242 # maxTTL, but can be equal.
3243 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
3244 # will overwrite the TTL set in all responses. The maximum allowed value is
3245 # 31,622,400s (1 year), noting that infrequently accessed objects may be
3246 # evicted from the cache before the defined TTL.
3247 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
3248 # origin.
3249 # Cache directives that attempt to set a max-age or s-maxage higher than
3250 # this, or an Expires header more than maxTTL seconds in the future will
3251 # be capped at the value of maxTTL, as if it were the value of an
3252 # s-maxage Cache-Control directive.
3253 # Headers sent to the client will not be modified.
3254 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
3255 # The maximum allowed value is 31,622,400s (1 year), noting that
3256 # infrequently accessed objects may be evicted from the cache before
3257 # the defined TTL.
3258 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
3259 # to apply fine-grained caching for common errors or redirects.
3260 # This can reduce the load on your origin and improve end-user
3261 # experience by reducing response latency.
3262 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
3263 # negative caching applies to responses with the specified response code
3264 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
3265 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
3266 # to all responses with the specified response code, and override any
3267 # caching headers.
3268 # By default, Cloud CDN will apply the following default TTLs to these
3269 # status codes:
3270 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
3271 # HTTP 404 (Not Found), 410 (Gone),
3272 # 451 (Unavailable For Legal Reasons): 120s
3273 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
3274 # These defaults can be overridden in negative_caching_policy.
3275 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
3276 # negative_caching must be enabled to configure negative_caching_policy.
3277 # Omitting the policy and leaving negative_caching enabled will use
3278 # Cloud CDN&#x27;s default cache TTLs.
3279 # Note that when specifying an explicit negative_caching_policy, you
3280 # should take care to specify a cache TTL for all response codes
3281 # that you wish to cache. Cloud CDN will not apply any default
3282 # negative caching when a policy exists.
3283 { # Specify CDN TTLs for response error codes.
3284 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
3285 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
3286 # specified as values, and you cannot specify a status code more than
3287 # once.
3288 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
3289 # corresponding status code.
3290 # The maximum allowed value is 1800s (30 minutes), noting that
3291 # infrequently accessed objects may be evicted from the cache before the
3292 # defined TTL.
3293 },
3294 ],
3295 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
3296 # requests into a small number of requests to the origin.
3297 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
3298 # content with the origin, or when an error is encountered when refreshing
3299 # the cache.
3300 # This setting defines the default &quot;max-stale&quot; duration for any cached
3301 # responses that do not specify a max-stale directive. Stale responses that
3302 # exceed the TTL configured here will not be served. The default limit
3303 # (max-stale) is 86400s (1 day), which will allow stale content to be
3304 # served up to this limit beyond the max-age (or s-maxage) of a cached
3305 # response.
3306 # The maximum allowed value is 604800 (1 week).
3307 # Set this to zero (0) to disable serve-while-stale.
3308 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
3309 # considered fresh. After this time period, the response will be
3310 # revalidated before being served. Defaults to 1hr (3600s). When serving
3311 # responses to signed URL requests, Cloud CDN will internally behave as
3312 # though all responses from this backend had a &quot;Cache-Control:
3313 # public, max-age=[TTL]&quot; header, regardless of any existing
3314 # Cache-Control header. The actual headers served in responses will not be
3315 # altered.
3316 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
3317 &quot;A String&quot;,
3318 ],
3319 },
3320 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
3321 # the client&#x27;s Accept-Encoding header.
3322 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
3323 # text format.
3324 &quot;customResponseHeaders&quot;: [ # Headers that the Application Load Balancer should add to proxied responses.
3325 &quot;A String&quot;,
3326 ],
3327 &quot;description&quot;: &quot;A String&quot;, # An optional textual description of the resource; provided by the client
3328 # when the resource is created.
3329 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
3330 # this backend bucket.
3331 &quot;enableCdn&quot;: True or False, # If true, enable Cloud CDN for this BackendBucket.
3332 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
3333 &quot;kind&quot;: &quot;compute#backendBucket&quot;, # Output only. Type of the resource.
3334 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # The value can only be INTERNAL_MANAGED for cross-region internal layer 7
3335 # load balancer.
3336 #
3337 # If loadBalancingScheme is not specified, the backend bucket can be used by
3338 # classic global external load balancers, or global application external load
3339 # balancers, or both.
3340 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
3341 # The name must be 1-63 characters long, and comply withRFC1035.
3342 # Specifically, the name must be 1-63 characters long and match the regular
3343 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
3344 # character must be a lowercase letter, and all following characters must
3345 # be a dash, lowercase letter, or digit, except the last character, which
3346 # cannot be a dash.
3347 &quot;params&quot;: { # Additional Backend Bucket parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
3348 # as part of resource payload.
3349 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
3350 # Tag keys and values have the same definition as resource
3351 # manager tags. The field is allowed for INSERT
3352 # only. The keys/values to set on the resource should be specified in
3353 # either ID { : } or Namespaced format
3354 # { : }.
3355 # For example the following are valid inputs:
3356 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
3357 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
3358 # Note:
3359 # * Invalid combinations of ID &amp; namespaced format is not supported. For
3360 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
3361 &quot;a_key&quot;: &quot;A String&quot;,
3362 },
3363 },
3364 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend bucket
3365 # resides. This field is not applicable to global backend buckets.
3366 # You must specify this field as part of the HTTP request URL. It is
3367 # not settable as a field in the request body.
3368 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3369 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
3370 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing that backend bucket.
3371 {
3372 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for UrlMaps referencing that
3373 # BackendBucket.
3374 },
3375 ],
3376 }
3377
3378 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
3379 that if you must retry your request, the server will know to ignore the
3380 request if it has already been completed.
3381
3382 For example, consider a situation where you make an initial request and
3383 the request times out. If you make the request again with the same
3384 request ID, the server can check if original operation with the same
3385 request ID was received, and if so, will ignore the second request. This
3386 prevents clients from accidentally creating duplicate commitments.
3387
3388 The request ID must be
3389 a valid UUID with the exception that zero UUID is not supported
3390 (00000000-0000-0000-0000-000000000000).
3391 x__xgafv: string, V1 error format.
3392 Allowed values
3393 1 - v1 error format
3394 2 - v2 error format
3395
3396 Returns:
3397 An object of the form:
3398
3399 { # Represents an Operation resource.
3400 #
3401 # Google Compute Engine has three Operation resources:
3402 #
3403 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
3404 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
3405 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
3406 #
3407 # You can use an operation resource to manage asynchronous API requests.
3408 # For more information, readHandling
3409 # API responses.
3410 #
3411 # Operations can be global, regional or zonal.
3412 #
3413 # - For global operations, use the `globalOperations`
3414 # resource.
3415 # - For regional operations, use the
3416 # `regionOperations` resource.
3417 # - For zonal operations, use
3418 # the `zoneOperations` resource.
3419 #
3420 #
3421 #
3422 # For more information, read
3423 # Global, Regional, and Zonal Resources.
3424 #
3425 # Note that completed Operation resources have a limited
3426 # retention period.
3427 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
3428 # Not present otherwise.
3429 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3430 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
3431 # set when the operation is created.
3432 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
3433 # text format.
3434 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
3435 # this field will be populated.
3436 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3437 # operation.
3438 {
3439 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3440 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3441 # details. There is a set of defined message types to use for providing
3442 # details.The syntax depends on the error code. For example,
3443 # QuotaExceededInfo will have details when the error code is
3444 # QUOTA_EXCEEDED.
3445 {
3446 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3447 #
3448 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3449 # is not enabled:
3450 #
3451 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3452 # &quot;domain&quot;: &quot;googleapis.com&quot;
3453 # &quot;metadata&quot;: {
3454 # &quot;resource&quot;: &quot;projects/123&quot;,
3455 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3456 # }
3457 # }
3458 #
3459 # This response indicates that the pubsub.googleapis.com API is not enabled.
3460 #
3461 # Example of an error that is returned when attempting to create a Spanner
3462 # instance in a region that is out of stock:
3463 #
3464 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3465 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3466 # &quot;metadata&quot;: {
3467 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3468 # }
3469 # }
3470 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3471 # is typically the registered service name of the tool or product that
3472 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3473 # generated by some common infrastructure, the error domain must be a
3474 # globally unique value that identifies the infrastructure. For Google API
3475 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3476 &quot;metadatas&quot;: { # Additional structured details about this error.
3477 #
3478 # Keys must match a regular expression of `a-z+` but should
3479 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3480 # length. When identifying the current value of an exceeded limit, the units
3481 # should be contained in the key, not the value. For example, rather than
3482 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3483 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3484 # instances that can be created in a single (batch) request.
3485 &quot;a_key&quot;: &quot;A String&quot;,
3486 },
3487 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3488 # proximate cause of the error. Error reasons are unique within a particular
3489 # domain of errors. This should be at most 63 characters and match a
3490 # regular expression of `A-Z+[A-Z0-9]`, which represents
3491 # UPPER_SNAKE_CASE.
3492 },
3493 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3494 #
3495 # For example, if a quota check failed with an error indicating the calling
3496 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3497 # directly to the right place in the developer console to flip the bit.
3498 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3499 { # Describes a URL link.
3500 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3501 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3502 },
3503 ],
3504 },
3505 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3506 # which can be attached to an RPC error.
3507 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3508 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3509 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3510 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3511 },
3512 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3513 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3514 &quot;a_key&quot;: &quot;A String&quot;,
3515 },
3516 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3517 # type or metric.
3518 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3519 # or metric.
3520 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3521 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3522 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3523 },
3524 },
3525 ],
3526 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3527 # This property is optional.
3528 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3529 },
3530 ],
3531 },
3532 &quot;getVersionOperationMetadata&quot;: {
3533 &quot;inlineSbomInfo&quot;: {
3534 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
3535 # appropriate identifiers.
3536 &quot;a_key&quot;: &quot;A String&quot;,
3537 },
3538 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
3539 # identifiers.
3540 &quot;a_key&quot;: &quot;A String&quot;,
3541 },
3542 },
3543 },
3544 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
3545 # message that was returned, such as `NOT FOUND`.
3546 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
3547 # status code that was returned. For example, a `404` means the
3548 # resource was not found.
3549 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
3550 # defined by the server.
3551 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
3552 # This value is inRFC3339
3553 # text format.
3554 &quot;instancesBulkInsertOperationMetadata&quot;: {
3555 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
3556 # Example key: zones/us-central1-a
3557 &quot;a_key&quot;: {
3558 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
3559 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
3560 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
3561 # error.
3562 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
3563 # if the flow is rolling forward or rolling back.
3564 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
3565 },
3566 },
3567 },
3568 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
3569 # Operation resources.
3570 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
3571 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
3572 # group of operations results from a `bulkInsert` API request.
3573 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
3574 # `update`, or `delete`, and so on.
3575 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
3576 # There is no requirement that this be linear or support any granularity of
3577 # operations. This should not be used to guess when the operation will be
3578 # complete. This number should monotonically increase as the operation
3579 # progresses.
3580 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
3581 # applicable when performing regional operations.
3582 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3583 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
3584 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
3585 # this field will contain information on all underlying zonal actions and
3586 # their state.
3587 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
3588 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
3589 # Example key: zones/us-central1-a
3590 &quot;a_key&quot;: {
3591 &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
3592 # populated.
3593 # different programming environments, including REST APIs and RPC APIs. It is
3594 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3595 # three pieces of data: error code, error message, and error details.
3596 #
3597 # You can find out more about this error model and how to work with it in the
3598 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3599 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
3600 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
3601 # message types for APIs to use.
3602 {
3603 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3604 },
3605 ],
3606 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
3607 # user-facing error message should be localized and sent in the
3608 # google.rpc.Status.details field, or localized by the client.
3609 },
3610 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
3611 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
3612 },
3613 },
3614 },
3615 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
3616 # This value is inRFC3339
3617 # text format.
3618 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
3619 # following:
3620 # `PENDING`, `RUNNING`, or `DONE`.
3621 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
3622 # operation.
3623 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
3624 # of the target resource.
3625 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
3626 # operations related to creating a snapshot, this points to the disk
3627 # that the snapshot was created from.
3628 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
3629 # `[email protected]` or
3630 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
3631 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
3632 # operation, this field will be populated.
3633 {
3634 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3635 # Engine returns NO_RESULTS_ON_PAGE if there
3636 # are no results in the response.
3637 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3638 # value format. For example:
3639 #
3640 # &quot;data&quot;: [
3641 # {
3642 # &quot;key&quot;: &quot;scope&quot;,
3643 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3644 # }
3645 {
3646 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3647 # returned. For example, for warnings where there are no results in a list
3648 # request for a particular zone, this key might be scope and
3649 # the key value might be the zone name. Other examples might be a key
3650 # indicating a deprecated resource and a suggested replacement, or a
3651 # warning about invalid network settings (for example, if an instance
3652 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3653 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3654 },
3655 ],
3656 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3657 },
3658 ],
3659 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
3660 # applicable when performing per-zone operations.
3661 }</pre>
3662 </div>
3663
3664 <div class="method">
3665 <code class="details" id="setEdgeSecurityPolicy">setEdgeSecurityPolicy(project, backendBucket, body=None, requestId=None, x__xgafv=None)</code>
3666 <pre>Sets the edge security policy for the specified backend bucket.
3667
3668 Args:
3669 project: string, Project ID for this request. (required)
3670 backendBucket: string, Name of the BackendBucket resource to which the security policy should be
3671 set. The name should conform to RFC1035. (required)
3672 body: object, The request body.
3673 The object takes the form of:
3674
3675 {
3676 &quot;securityPolicy&quot;: &quot;A String&quot;,
3677 }
3678
3679 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
3680 that if you must retry your request, the server will know to ignore the
3681 request if it has already been completed.
3682
3683 For example, consider a situation where you make an initial request and
3684 the request times out. If you make the request again with the same
3685 request ID, the server can check if original operation with the same
3686 request ID was received, and if so, will ignore the second request. This
3687 prevents clients from accidentally creating duplicate commitments.
3688
3689 The request ID must be
3690 a valid UUID with the exception that zero UUID is not supported
3691 (00000000-0000-0000-0000-000000000000).
3692 x__xgafv: string, V1 error format.
3693 Allowed values
3694 1 - v1 error format
3695 2 - v2 error format
3696
3697 Returns:
3698 An object of the form:
3699
3700 { # Represents an Operation resource.
3701 #
3702 # Google Compute Engine has three Operation resources:
3703 #
3704 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
3705 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
3706 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
3707 #
3708 # You can use an operation resource to manage asynchronous API requests.
3709 # For more information, readHandling
3710 # API responses.
3711 #
3712 # Operations can be global, regional or zonal.
3713 #
3714 # - For global operations, use the `globalOperations`
3715 # resource.
3716 # - For regional operations, use the
3717 # `regionOperations` resource.
3718 # - For zonal operations, use
3719 # the `zoneOperations` resource.
3720 #
3721 #
3722 #
3723 # For more information, read
3724 # Global, Regional, and Zonal Resources.
3725 #
3726 # Note that completed Operation resources have a limited
3727 # retention period.
3728 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
3729 # Not present otherwise.
3730 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3731 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
3732 # set when the operation is created.
3733 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
3734 # text format.
3735 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
3736 # this field will be populated.
3737 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3738 # operation.
3739 {
3740 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3741 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3742 # details. There is a set of defined message types to use for providing
3743 # details.The syntax depends on the error code. For example,
3744 # QuotaExceededInfo will have details when the error code is
3745 # QUOTA_EXCEEDED.
3746 {
3747 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3748 #
3749 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3750 # is not enabled:
3751 #
3752 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3753 # &quot;domain&quot;: &quot;googleapis.com&quot;
3754 # &quot;metadata&quot;: {
3755 # &quot;resource&quot;: &quot;projects/123&quot;,
3756 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3757 # }
3758 # }
3759 #
3760 # This response indicates that the pubsub.googleapis.com API is not enabled.
3761 #
3762 # Example of an error that is returned when attempting to create a Spanner
3763 # instance in a region that is out of stock:
3764 #
3765 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3766 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3767 # &quot;metadata&quot;: {
3768 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3769 # }
3770 # }
3771 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3772 # is typically the registered service name of the tool or product that
3773 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3774 # generated by some common infrastructure, the error domain must be a
3775 # globally unique value that identifies the infrastructure. For Google API
3776 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3777 &quot;metadatas&quot;: { # Additional structured details about this error.
3778 #
3779 # Keys must match a regular expression of `a-z+` but should
3780 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3781 # length. When identifying the current value of an exceeded limit, the units
3782 # should be contained in the key, not the value. For example, rather than
3783 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3784 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3785 # instances that can be created in a single (batch) request.
3786 &quot;a_key&quot;: &quot;A String&quot;,
3787 },
3788 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3789 # proximate cause of the error. Error reasons are unique within a particular
3790 # domain of errors. This should be at most 63 characters and match a
3791 # regular expression of `A-Z+[A-Z0-9]`, which represents
3792 # UPPER_SNAKE_CASE.
3793 },
3794 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3795 #
3796 # For example, if a quota check failed with an error indicating the calling
3797 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3798 # directly to the right place in the developer console to flip the bit.
3799 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3800 { # Describes a URL link.
3801 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3802 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3803 },
3804 ],
3805 },
3806 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3807 # which can be attached to an RPC error.
3808 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3809 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3810 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3811 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3812 },
3813 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3814 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3815 &quot;a_key&quot;: &quot;A String&quot;,
3816 },
3817 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3818 # type or metric.
3819 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3820 # or metric.
3821 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3822 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3823 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3824 },
3825 },
3826 ],
3827 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3828 # This property is optional.
3829 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3830 },
3831 ],
3832 },
3833 &quot;getVersionOperationMetadata&quot;: {
3834 &quot;inlineSbomInfo&quot;: {
3835 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
3836 # appropriate identifiers.
3837 &quot;a_key&quot;: &quot;A String&quot;,
3838 },
3839 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
3840 # identifiers.
3841 &quot;a_key&quot;: &quot;A String&quot;,
3842 },
3843 },
3844 },
3845 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
3846 # message that was returned, such as `NOT FOUND`.
3847 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
3848 # status code that was returned. For example, a `404` means the
3849 # resource was not found.
3850 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
3851 # defined by the server.
3852 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
3853 # This value is inRFC3339
3854 # text format.
3855 &quot;instancesBulkInsertOperationMetadata&quot;: {
3856 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
3857 # Example key: zones/us-central1-a
3858 &quot;a_key&quot;: {
3859 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
3860 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
3861 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
3862 # error.
3863 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
3864 # if the flow is rolling forward or rolling back.
3865 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
3866 },
3867 },
3868 },
3869 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
3870 # Operation resources.
3871 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
3872 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
3873 # group of operations results from a `bulkInsert` API request.
3874 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
3875 # `update`, or `delete`, and so on.
3876 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
3877 # There is no requirement that this be linear or support any granularity of
3878 # operations. This should not be used to guess when the operation will be
3879 # complete. This number should monotonically increase as the operation
3880 # progresses.
3881 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
3882 # applicable when performing regional operations.
3883 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3884 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
3885 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
3886 # this field will contain information on all underlying zonal actions and
3887 # their state.
3888 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
3889 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
3890 # Example key: zones/us-central1-a
3891 &quot;a_key&quot;: {
3892 &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
3893 # populated.
3894 # different programming environments, including REST APIs and RPC APIs. It is
3895 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3896 # three pieces of data: error code, error message, and error details.
3897 #
3898 # You can find out more about this error model and how to work with it in the
3899 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3900 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
3901 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
3902 # message types for APIs to use.
3903 {
3904 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3905 },
3906 ],
3907 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
3908 # user-facing error message should be localized and sent in the
3909 # google.rpc.Status.details field, or localized by the client.
3910 },
3911 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
3912 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
3913 },
3914 },
3915 },
3916 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
3917 # This value is inRFC3339
3918 # text format.
3919 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
3920 # following:
3921 # `PENDING`, `RUNNING`, or `DONE`.
3922 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
3923 # operation.
3924 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
3925 # of the target resource.
3926 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
3927 # operations related to creating a snapshot, this points to the disk
3928 # that the snapshot was created from.
3929 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
3930 # `[email protected]` or
3931 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
3932 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
3933 # operation, this field will be populated.
3934 {
3935 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3936 # Engine returns NO_RESULTS_ON_PAGE if there
3937 # are no results in the response.
3938 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3939 # value format. For example:
3940 #
3941 # &quot;data&quot;: [
3942 # {
3943 # &quot;key&quot;: &quot;scope&quot;,
3944 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3945 # }
3946 {
3947 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3948 # returned. For example, for warnings where there are no results in a list
3949 # request for a particular zone, this key might be scope and
3950 # the key value might be the zone name. Other examples might be a key
3951 # indicating a deprecated resource and a suggested replacement, or a
3952 # warning about invalid network settings (for example, if an instance
3953 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3954 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3955 },
3956 ],
3957 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3958 },
3959 ],
3960 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
3961 # applicable when performing per-zone operations.
3962 }</pre>
3963 </div>
3964
3965 <div class="method">
3966 <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</code>
3967 <pre>Sets the access control policy on the specified resource.
3968 Replaces any existing policy.
3969
3970 Args:
3971 project: string, Project ID for this request. (required)
3972 resource: string, Name or id of the resource for this request. (required)
3973 body: object, The request body.
3974 The object takes the form of:
3975
3976 {
3977 &quot;bindings&quot;: [ # Flatten Policy to create a backward compatible wire-format.
3978 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
3979 { # Associates `members`, or principals, with a `role`.
3980 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
3981 #
3982 # If the condition evaluates to `true`, then this binding applies to the
3983 # current request.
3984 #
3985 # If the condition evaluates to `false`, then this binding does not apply to
3986 # the current request. However, a different role binding might grant the same
3987 # role to one or more of the principals in this binding.
3988 #
3989 # To learn which resources support conditions in their IAM policies, see the
3990 # [IAM
3991 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3992 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
3993 # are documented at https://github.com/google/cel-spec.
3994 #
3995 # Example (Comparison):
3996 #
3997 # title: &quot;Summary size limit&quot;
3998 # description: &quot;Determines if a summary is less than 100 chars&quot;
3999 # expression: &quot;document.summary.size() &lt; 100&quot;
4000 #
4001 # Example (Equality):
4002 #
4003 # title: &quot;Requestor is owner&quot;
4004 # description: &quot;Determines if requestor is the document owner&quot;
4005 # expression: &quot;document.owner == request.auth.claims.email&quot;
4006 #
4007 # Example (Logic):
4008 #
4009 # title: &quot;Public documents&quot;
4010 # description: &quot;Determine whether the document should be publicly visible&quot;
4011 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
4012 #
4013 # Example (Data Manipulation):
4014 #
4015 # title: &quot;Notification string&quot;
4016 # description: &quot;Create a notification string with a timestamp.&quot;
4017 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
4018 #
4019 # The exact variables and functions that may be referenced within an expression
4020 # are determined by the service that evaluates it. See the service
4021 # documentation for additional information.
4022 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
4023 # describes the expression, e.g. when hovered over it in a UI.
4024 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
4025 # syntax.
4026 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
4027 # reporting, e.g. a file name and a position in the file.
4028 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
4029 # its purpose. This can be used e.g. in UIs which allow to enter the
4030 # expression.
4031 },
4032 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
4033 # `members` can have the following values:
4034 #
4035 # * `allUsers`: A special identifier that represents anyone who is
4036 # on the internet; with or without a Google account.
4037 #
4038 # * `allAuthenticatedUsers`: A special identifier that represents anyone
4039 # who is authenticated with a Google account or a service account.
4040 # Does not include identities that come from external identity providers
4041 # (IdPs) through identity federation.
4042 #
4043 # * `user:{emailid}`: An email address that represents a specific Google
4044 # account. For example, `[email protected]` .
4045 #
4046 #
4047 # * `serviceAccount:{emailid}`: An email address that represents a Google
4048 # service account. For example,
4049 # `[email protected]`.
4050 #
4051 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
4052 # identifier for a
4053 # [Kubernetes service
4054 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
4055 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
4056 #
4057 # * `group:{emailid}`: An email address that represents a Google group.
4058 # For example, `[email protected]`.
4059 #
4060 #
4061 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
4062 # users of that domain. For example, `google.com` or `example.com`.
4063 #
4064 #
4065 #
4066 #
4067 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
4068 # A single identity in a workforce identity pool.
4069 #
4070 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
4071 # All workforce identities in a group.
4072 #
4073 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
4074 # All workforce identities with a specific attribute value.
4075 #
4076 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
4077 # All identities in a workforce identity pool.
4078 #
4079 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
4080 # A single identity in a workload identity pool.
4081 #
4082 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
4083 # A workload identity pool group.
4084 #
4085 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
4086 # All identities in a workload identity pool with a certain attribute.
4087 #
4088 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
4089 # All identities in a workload identity pool.
4090 #
4091 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
4092 # identifier) representing a user that has been recently deleted. For
4093 # example, `[email protected]?uid=123456789012345678901`. If the user is
4094 # recovered, this value reverts to `user:{emailid}` and the recovered user
4095 # retains the role in the binding.
4096 #
4097 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
4098 # unique identifier) representing a service account that has been recently
4099 # deleted. For example,
4100 # `[email protected]?uid=123456789012345678901`.
4101 # If the service account is undeleted, this value reverts to
4102 # `serviceAccount:{emailid}` and the undeleted service account retains the
4103 # role in the binding.
4104 #
4105 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
4106 # identifier) representing a Google group that has been recently
4107 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
4108 # the group is recovered, this value reverts to `group:{emailid}` and the
4109 # recovered group retains the role in the binding.
4110 #
4111 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
4112 # Deleted single identity in a workforce identity pool. For example,
4113 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
4114 &quot;A String&quot;,
4115 ],
4116 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
4117 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
4118 #
4119 # For an overview of the IAM roles and permissions, see the
4120 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
4121 # a list of the available pre-defined roles, see
4122 # [here](https://cloud.google.com/iam/docs/understanding-roles).
4123 },
4124 ],
4125 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
4126 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
4127 &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
4128 # the policy is limited to a few 10s of KB. An empty policy is in general a
4129 # valid policy but certain services (like Projects) might reject them.
4130 # controls for Google Cloud resources.
4131 #
4132 #
4133 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
4134 # `members`, or principals, to a single `role`. Principals can be user
4135 # accounts, service accounts, Google groups, and domains (such as G Suite). A
4136 # `role` is a named list of permissions; each `role` can be an IAM predefined
4137 # role or a user-created custom role.
4138 #
4139 # For some types of Google Cloud resources, a `binding` can also specify a
4140 # `condition`, which is a logical expression that allows access to a resource
4141 # only if the expression evaluates to `true`. A condition can add constraints
4142 # based on attributes of the request, the resource, or both. To learn which
4143 # resources support conditions in their IAM policies, see the
4144 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
4145 #
4146 # **JSON example:**
4147 #
4148 # ```
4149 # {
4150 # &quot;bindings&quot;: [
4151 # {
4152 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
4153 # &quot;members&quot;: [
4154 # &quot;user:[email protected]&quot;,
4155 # &quot;group:[email protected]&quot;,
4156 # &quot;domain:google.com&quot;,
4157 # &quot;serviceAccount:[email protected]&quot;
4158 # ]
4159 # },
4160 # {
4161 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
4162 # &quot;members&quot;: [
4163 # &quot;user:[email protected]&quot;
4164 # ],
4165 # &quot;condition&quot;: {
4166 # &quot;title&quot;: &quot;expirable access&quot;,
4167 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
4168 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
4169 # }
4170 # }
4171 # ],
4172 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
4173 # &quot;version&quot;: 3
4174 # }
4175 # ```
4176 #
4177 # **YAML example:**
4178 #
4179 # ```
4180 # bindings:
4181 # - members:
4182 # - user:[email protected]
4183 # - group:[email protected]
4184 # - domain:google.com
4185 # - serviceAccount:[email protected]
4186 # role: roles/resourcemanager.organizationAdmin
4187 # - members:
4188 # - user:[email protected]
4189 # role: roles/resourcemanager.organizationViewer
4190 # condition:
4191 # title: expirable access
4192 # description: Does not grant access after Sep 2020
4193 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
4194 # etag: BwWWja0YfJA=
4195 # version: 3
4196 # ```
4197 #
4198 # For a description of IAM and its features, see the
4199 # [IAM documentation](https://cloud.google.com/iam/docs/).
4200 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
4201 { # Specifies the audit configuration for a service.
4202 # The configuration determines which permission types are logged, and what
4203 # identities, if any, are exempted from logging.
4204 # An AuditConfig must have one or more AuditLogConfigs.
4205 #
4206 # If there are AuditConfigs for both `allServices` and a specific service,
4207 # the union of the two AuditConfigs is used for that service: the log_types
4208 # specified in each AuditConfig are enabled, and the exempted_members in each
4209 # AuditLogConfig are exempted.
4210 #
4211 # Example Policy with multiple AuditConfigs:
4212 #
4213 # {
4214 # &quot;audit_configs&quot;: [
4215 # {
4216 # &quot;service&quot;: &quot;allServices&quot;,
4217 # &quot;audit_log_configs&quot;: [
4218 # {
4219 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
4220 # &quot;exempted_members&quot;: [
4221 # &quot;user:[email protected]&quot;
4222 # ]
4223 # },
4224 # {
4225 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
4226 # },
4227 # {
4228 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
4229 # }
4230 # ]
4231 # },
4232 # {
4233 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
4234 # &quot;audit_log_configs&quot;: [
4235 # {
4236 # &quot;log_type&quot;: &quot;DATA_READ&quot;
4237 # },
4238 # {
4239 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
4240 # &quot;exempted_members&quot;: [
4241 # &quot;user:[email protected]&quot;
4242 # ]
4243 # }
4244 # ]
4245 # }
4246 # ]
4247 # }
4248 #
4249 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
4250 # logging. It also exempts `[email protected]` from DATA_READ logging, and
4251 # `[email protected]` from DATA_WRITE logging.
4252 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
4253 { # Provides the configuration for logging a type of permissions.
4254 # Example:
4255 #
4256 # {
4257 # &quot;audit_log_configs&quot;: [
4258 # {
4259 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
4260 # &quot;exempted_members&quot;: [
4261 # &quot;user:[email protected]&quot;
4262 # ]
4263 # },
4264 # {
4265 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
4266 # }
4267 # ]
4268 # }
4269 #
4270 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
4271 # [email protected] from DATA_READ logging.
4272 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
4273 # permission.
4274 # Follows the same format of Binding.members.
4275 &quot;A String&quot;,
4276 ],
4277 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
4278 },
4279 ],
4280 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
4281 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
4282 # `allServices` is a special value that covers all services.
4283 },
4284 ],
4285 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
4286 # may specify a `condition` that determines how and when the `bindings` are
4287 # applied. Each of the `bindings` must contain at least one principal.
4288 #
4289 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
4290 # of these principals can be Google groups. Each occurrence of a principal
4291 # counts towards these limits. For example, if the `bindings` grant 50
4292 # different roles to `user:[email protected]`, and not to any other
4293 # principal, then you can add another 1,450 principals to the `bindings` in
4294 # the `Policy`.
4295 { # Associates `members`, or principals, with a `role`.
4296 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
4297 #
4298 # If the condition evaluates to `true`, then this binding applies to the
4299 # current request.
4300 #
4301 # If the condition evaluates to `false`, then this binding does not apply to
4302 # the current request. However, a different role binding might grant the same
4303 # role to one or more of the principals in this binding.
4304 #
4305 # To learn which resources support conditions in their IAM policies, see the
4306 # [IAM
4307 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
4308 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
4309 # are documented at https://github.com/google/cel-spec.
4310 #
4311 # Example (Comparison):
4312 #
4313 # title: &quot;Summary size limit&quot;
4314 # description: &quot;Determines if a summary is less than 100 chars&quot;
4315 # expression: &quot;document.summary.size() &lt; 100&quot;
4316 #
4317 # Example (Equality):
4318 #
4319 # title: &quot;Requestor is owner&quot;
4320 # description: &quot;Determines if requestor is the document owner&quot;
4321 # expression: &quot;document.owner == request.auth.claims.email&quot;
4322 #
4323 # Example (Logic):
4324 #
4325 # title: &quot;Public documents&quot;
4326 # description: &quot;Determine whether the document should be publicly visible&quot;
4327 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
4328 #
4329 # Example (Data Manipulation):
4330 #
4331 # title: &quot;Notification string&quot;
4332 # description: &quot;Create a notification string with a timestamp.&quot;
4333 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
4334 #
4335 # The exact variables and functions that may be referenced within an expression
4336 # are determined by the service that evaluates it. See the service
4337 # documentation for additional information.
4338 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
4339 # describes the expression, e.g. when hovered over it in a UI.
4340 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
4341 # syntax.
4342 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
4343 # reporting, e.g. a file name and a position in the file.
4344 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
4345 # its purpose. This can be used e.g. in UIs which allow to enter the
4346 # expression.
4347 },
4348 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
4349 # `members` can have the following values:
4350 #
4351 # * `allUsers`: A special identifier that represents anyone who is
4352 # on the internet; with or without a Google account.
4353 #
4354 # * `allAuthenticatedUsers`: A special identifier that represents anyone
4355 # who is authenticated with a Google account or a service account.
4356 # Does not include identities that come from external identity providers
4357 # (IdPs) through identity federation.
4358 #
4359 # * `user:{emailid}`: An email address that represents a specific Google
4360 # account. For example, `[email protected]` .
4361 #
4362 #
4363 # * `serviceAccount:{emailid}`: An email address that represents a Google
4364 # service account. For example,
4365 # `[email protected]`.
4366 #
4367 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
4368 # identifier for a
4369 # [Kubernetes service
4370 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
4371 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
4372 #
4373 # * `group:{emailid}`: An email address that represents a Google group.
4374 # For example, `[email protected]`.
4375 #
4376 #
4377 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
4378 # users of that domain. For example, `google.com` or `example.com`.
4379 #
4380 #
4381 #
4382 #
4383 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
4384 # A single identity in a workforce identity pool.
4385 #
4386 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
4387 # All workforce identities in a group.
4388 #
4389 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
4390 # All workforce identities with a specific attribute value.
4391 #
4392 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
4393 # All identities in a workforce identity pool.
4394 #
4395 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
4396 # A single identity in a workload identity pool.
4397 #
4398 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
4399 # A workload identity pool group.
4400 #
4401 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
4402 # All identities in a workload identity pool with a certain attribute.
4403 #
4404 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
4405 # All identities in a workload identity pool.
4406 #
4407 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
4408 # identifier) representing a user that has been recently deleted. For
4409 # example, `[email protected]?uid=123456789012345678901`. If the user is
4410 # recovered, this value reverts to `user:{emailid}` and the recovered user
4411 # retains the role in the binding.
4412 #
4413 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
4414 # unique identifier) representing a service account that has been recently
4415 # deleted. For example,
4416 # `[email protected]?uid=123456789012345678901`.
4417 # If the service account is undeleted, this value reverts to
4418 # `serviceAccount:{emailid}` and the undeleted service account retains the
4419 # role in the binding.
4420 #
4421 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
4422 # identifier) representing a Google group that has been recently
4423 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
4424 # the group is recovered, this value reverts to `group:{emailid}` and the
4425 # recovered group retains the role in the binding.
4426 #
4427 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
4428 # Deleted single identity in a workforce identity pool. For example,
4429 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
4430 &quot;A String&quot;,
4431 ],
4432 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
4433 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
4434 #
4435 # For an overview of the IAM roles and permissions, see the
4436 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
4437 # a list of the available pre-defined roles, see
4438 # [here](https://cloud.google.com/iam/docs/understanding-roles).
4439 },
4440 ],
4441 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
4442 # prevent simultaneous updates of a policy from overwriting each other.
4443 # It is strongly suggested that systems make use of the `etag` in the
4444 # read-modify-write cycle to perform policy updates in order to avoid race
4445 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
4446 # systems are expected to put that etag in the request to `setIamPolicy` to
4447 # ensure that their change will be applied to the same version of the policy.
4448 #
4449 # **Important:** If you use IAM Conditions, you must include the `etag` field
4450 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
4451 # you to overwrite a version `3` policy with a version `1` policy, and all of
4452 # the conditions in the version `3` policy are lost.
4453 &quot;version&quot;: 42, # Specifies the format of the policy.
4454 #
4455 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
4456 # are rejected.
4457 #
4458 # Any operation that affects conditional role bindings must specify version
4459 # `3`. This requirement applies to the following operations:
4460 #
4461 # * Getting a policy that includes a conditional role binding
4462 # * Adding a conditional role binding to a policy
4463 # * Changing a conditional role binding in a policy
4464 # * Removing any role binding, with or without a condition, from a policy
4465 # that includes conditions
4466 #
4467 # **Important:** If you use IAM Conditions, you must include the `etag` field
4468 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
4469 # you to overwrite a version `3` policy with a version `1` policy, and all of
4470 # the conditions in the version `3` policy are lost.
4471 #
4472 # If a policy does not include any conditions, operations on that policy may
4473 # specify any valid version or leave the field unset.
4474 #
4475 # To learn which resources support conditions in their IAM policies, see the
4476 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
4477 },
4478 }
4479
4480 x__xgafv: string, V1 error format.
4481 Allowed values
4482 1 - v1 error format
4483 2 - v2 error format
4484
4485 Returns:
4486 An object of the form:
4487
4488 { # An Identity and Access Management (IAM) policy, which specifies access
4489 # controls for Google Cloud resources.
4490 #
4491 #
4492 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
4493 # `members`, or principals, to a single `role`. Principals can be user
4494 # accounts, service accounts, Google groups, and domains (such as G Suite). A
4495 # `role` is a named list of permissions; each `role` can be an IAM predefined
4496 # role or a user-created custom role.
4497 #
4498 # For some types of Google Cloud resources, a `binding` can also specify a
4499 # `condition`, which is a logical expression that allows access to a resource
4500 # only if the expression evaluates to `true`. A condition can add constraints
4501 # based on attributes of the request, the resource, or both. To learn which
4502 # resources support conditions in their IAM policies, see the
4503 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
4504 #
4505 # **JSON example:**
4506 #
4507 # ```
4508 # {
4509 # &quot;bindings&quot;: [
4510 # {
4511 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
4512 # &quot;members&quot;: [
4513 # &quot;user:[email protected]&quot;,
4514 # &quot;group:[email protected]&quot;,
4515 # &quot;domain:google.com&quot;,
4516 # &quot;serviceAccount:[email protected]&quot;
4517 # ]
4518 # },
4519 # {
4520 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
4521 # &quot;members&quot;: [
4522 # &quot;user:[email protected]&quot;
4523 # ],
4524 # &quot;condition&quot;: {
4525 # &quot;title&quot;: &quot;expirable access&quot;,
4526 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
4527 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
4528 # }
4529 # }
4530 # ],
4531 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
4532 # &quot;version&quot;: 3
4533 # }
4534 # ```
4535 #
4536 # **YAML example:**
4537 #
4538 # ```
4539 # bindings:
4540 # - members:
4541 # - user:[email protected]
4542 # - group:[email protected]
4543 # - domain:google.com
4544 # - serviceAccount:[email protected]
4545 # role: roles/resourcemanager.organizationAdmin
4546 # - members:
4547 # - user:[email protected]
4548 # role: roles/resourcemanager.organizationViewer
4549 # condition:
4550 # title: expirable access
4551 # description: Does not grant access after Sep 2020
4552 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
4553 # etag: BwWWja0YfJA=
4554 # version: 3
4555 # ```
4556 #
4557 # For a description of IAM and its features, see the
4558 # [IAM documentation](https://cloud.google.com/iam/docs/).
4559 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
4560 { # Specifies the audit configuration for a service.
4561 # The configuration determines which permission types are logged, and what
4562 # identities, if any, are exempted from logging.
4563 # An AuditConfig must have one or more AuditLogConfigs.
4564 #
4565 # If there are AuditConfigs for both `allServices` and a specific service,
4566 # the union of the two AuditConfigs is used for that service: the log_types
4567 # specified in each AuditConfig are enabled, and the exempted_members in each
4568 # AuditLogConfig are exempted.
4569 #
4570 # Example Policy with multiple AuditConfigs:
4571 #
4572 # {
4573 # &quot;audit_configs&quot;: [
4574 # {
4575 # &quot;service&quot;: &quot;allServices&quot;,
4576 # &quot;audit_log_configs&quot;: [
4577 # {
4578 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
4579 # &quot;exempted_members&quot;: [
4580 # &quot;user:[email protected]&quot;
4581 # ]
4582 # },
4583 # {
4584 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
4585 # },
4586 # {
4587 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
4588 # }
4589 # ]
4590 # },
4591 # {
4592 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
4593 # &quot;audit_log_configs&quot;: [
4594 # {
4595 # &quot;log_type&quot;: &quot;DATA_READ&quot;
4596 # },
4597 # {
4598 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
4599 # &quot;exempted_members&quot;: [
4600 # &quot;user:[email protected]&quot;
4601 # ]
4602 # }
4603 # ]
4604 # }
4605 # ]
4606 # }
4607 #
4608 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
4609 # logging. It also exempts `[email protected]` from DATA_READ logging, and
4610 # `[email protected]` from DATA_WRITE logging.
4611 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
4612 { # Provides the configuration for logging a type of permissions.
4613 # Example:
4614 #
4615 # {
4616 # &quot;audit_log_configs&quot;: [
4617 # {
4618 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
4619 # &quot;exempted_members&quot;: [
4620 # &quot;user:[email protected]&quot;
4621 # ]
4622 # },
4623 # {
4624 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
4625 # }
4626 # ]
4627 # }
4628 #
4629 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
4630 # [email protected] from DATA_READ logging.
4631 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
4632 # permission.
4633 # Follows the same format of Binding.members.
4634 &quot;A String&quot;,
4635 ],
4636 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
4637 },
4638 ],
4639 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
4640 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
4641 # `allServices` is a special value that covers all services.
4642 },
4643 ],
4644 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
4645 # may specify a `condition` that determines how and when the `bindings` are
4646 # applied. Each of the `bindings` must contain at least one principal.
4647 #
4648 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
4649 # of these principals can be Google groups. Each occurrence of a principal
4650 # counts towards these limits. For example, if the `bindings` grant 50
4651 # different roles to `user:[email protected]`, and not to any other
4652 # principal, then you can add another 1,450 principals to the `bindings` in
4653 # the `Policy`.
4654 { # Associates `members`, or principals, with a `role`.
4655 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
4656 #
4657 # If the condition evaluates to `true`, then this binding applies to the
4658 # current request.
4659 #
4660 # If the condition evaluates to `false`, then this binding does not apply to
4661 # the current request. However, a different role binding might grant the same
4662 # role to one or more of the principals in this binding.
4663 #
4664 # To learn which resources support conditions in their IAM policies, see the
4665 # [IAM
4666 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
4667 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
4668 # are documented at https://github.com/google/cel-spec.
4669 #
4670 # Example (Comparison):
4671 #
4672 # title: &quot;Summary size limit&quot;
4673 # description: &quot;Determines if a summary is less than 100 chars&quot;
4674 # expression: &quot;document.summary.size() &lt; 100&quot;
4675 #
4676 # Example (Equality):
4677 #
4678 # title: &quot;Requestor is owner&quot;
4679 # description: &quot;Determines if requestor is the document owner&quot;
4680 # expression: &quot;document.owner == request.auth.claims.email&quot;
4681 #
4682 # Example (Logic):
4683 #
4684 # title: &quot;Public documents&quot;
4685 # description: &quot;Determine whether the document should be publicly visible&quot;
4686 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
4687 #
4688 # Example (Data Manipulation):
4689 #
4690 # title: &quot;Notification string&quot;
4691 # description: &quot;Create a notification string with a timestamp.&quot;
4692 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
4693 #
4694 # The exact variables and functions that may be referenced within an expression
4695 # are determined by the service that evaluates it. See the service
4696 # documentation for additional information.
4697 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
4698 # describes the expression, e.g. when hovered over it in a UI.
4699 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
4700 # syntax.
4701 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
4702 # reporting, e.g. a file name and a position in the file.
4703 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
4704 # its purpose. This can be used e.g. in UIs which allow to enter the
4705 # expression.
4706 },
4707 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
4708 # `members` can have the following values:
4709 #
4710 # * `allUsers`: A special identifier that represents anyone who is
4711 # on the internet; with or without a Google account.
4712 #
4713 # * `allAuthenticatedUsers`: A special identifier that represents anyone
4714 # who is authenticated with a Google account or a service account.
4715 # Does not include identities that come from external identity providers
4716 # (IdPs) through identity federation.
4717 #
4718 # * `user:{emailid}`: An email address that represents a specific Google
4719 # account. For example, `[email protected]` .
4720 #
4721 #
4722 # * `serviceAccount:{emailid}`: An email address that represents a Google
4723 # service account. For example,
4724 # `[email protected]`.
4725 #
4726 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
4727 # identifier for a
4728 # [Kubernetes service
4729 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
4730 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
4731 #
4732 # * `group:{emailid}`: An email address that represents a Google group.
4733 # For example, `[email protected]`.
4734 #
4735 #
4736 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
4737 # users of that domain. For example, `google.com` or `example.com`.
4738 #
4739 #
4740 #
4741 #
4742 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
4743 # A single identity in a workforce identity pool.
4744 #
4745 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
4746 # All workforce identities in a group.
4747 #
4748 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
4749 # All workforce identities with a specific attribute value.
4750 #
4751 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
4752 # All identities in a workforce identity pool.
4753 #
4754 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
4755 # A single identity in a workload identity pool.
4756 #
4757 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
4758 # A workload identity pool group.
4759 #
4760 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
4761 # All identities in a workload identity pool with a certain attribute.
4762 #
4763 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
4764 # All identities in a workload identity pool.
4765 #
4766 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
4767 # identifier) representing a user that has been recently deleted. For
4768 # example, `[email protected]?uid=123456789012345678901`. If the user is
4769 # recovered, this value reverts to `user:{emailid}` and the recovered user
4770 # retains the role in the binding.
4771 #
4772 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
4773 # unique identifier) representing a service account that has been recently
4774 # deleted. For example,
4775 # `[email protected]?uid=123456789012345678901`.
4776 # If the service account is undeleted, this value reverts to
4777 # `serviceAccount:{emailid}` and the undeleted service account retains the
4778 # role in the binding.
4779 #
4780 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
4781 # identifier) representing a Google group that has been recently
4782 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
4783 # the group is recovered, this value reverts to `group:{emailid}` and the
4784 # recovered group retains the role in the binding.
4785 #
4786 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
4787 # Deleted single identity in a workforce identity pool. For example,
4788 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
4789 &quot;A String&quot;,
4790 ],
4791 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
4792 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
4793 #
4794 # For an overview of the IAM roles and permissions, see the
4795 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
4796 # a list of the available pre-defined roles, see
4797 # [here](https://cloud.google.com/iam/docs/understanding-roles).
4798 },
4799 ],
4800 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
4801 # prevent simultaneous updates of a policy from overwriting each other.
4802 # It is strongly suggested that systems make use of the `etag` in the
4803 # read-modify-write cycle to perform policy updates in order to avoid race
4804 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
4805 # systems are expected to put that etag in the request to `setIamPolicy` to
4806 # ensure that their change will be applied to the same version of the policy.
4807 #
4808 # **Important:** If you use IAM Conditions, you must include the `etag` field
4809 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
4810 # you to overwrite a version `3` policy with a version `1` policy, and all of
4811 # the conditions in the version `3` policy are lost.
4812 &quot;version&quot;: 42, # Specifies the format of the policy.
4813 #
4814 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
4815 # are rejected.
4816 #
4817 # Any operation that affects conditional role bindings must specify version
4818 # `3`. This requirement applies to the following operations:
4819 #
4820 # * Getting a policy that includes a conditional role binding
4821 # * Adding a conditional role binding to a policy
4822 # * Changing a conditional role binding in a policy
4823 # * Removing any role binding, with or without a condition, from a policy
4824 # that includes conditions
4825 #
4826 # **Important:** If you use IAM Conditions, you must include the `etag` field
4827 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
4828 # you to overwrite a version `3` policy with a version `1` policy, and all of
4829 # the conditions in the version `3` policy are lost.
4830 #
4831 # If a policy does not include any conditions, operations on that policy may
4832 # specify any valid version or leave the field unset.
4833 #
4834 # To learn which resources support conditions in their IAM policies, see the
4835 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
4836 }</pre>
4837 </div>
4838
4839 <div class="method">
4840 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code>
4841 <pre>Returns permissions that a caller has on the specified resource.
4842
4843 Args:
4844 project: string, Project ID for this request. (required)
4845 resource: string, Name or id of the resource for this request. (required)
4846 body: object, The request body.
4847 The object takes the form of:
4848
4849 {
4850 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
4851 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
4852 &quot;A String&quot;,
4853 ],
4854 }
4855
4856 x__xgafv: string, V1 error format.
4857 Allowed values
4858 1 - v1 error format
4859 2 - v2 error format
4860
4861 Returns:
4862 An object of the form:
4863
4864 {
4865 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
4866 # allowed.
4867 &quot;A String&quot;,
4868 ],
4869 }</pre>
4870 </div>
4871
4872 <div class="method">
4873 <code class="details" id="update">update(project, backendBucket, body=None, requestId=None, x__xgafv=None)</code>
4874 <pre>Updates the specified BackendBucket resource with the data included in the
4875 request.
4876
4877 Args:
4878 project: string, Project ID for this request. (required)
4879 backendBucket: string, Name of the BackendBucket resource to update. (required)
4880 body: object, The request body.
4881 The object takes the form of:
4882
4883 { # Represents a Cloud Storage Bucket resource.
4884 #
4885 # This Cloud Storage bucket resource is referenced by a URL map of a load
4886 # balancer. For more information, readBackend Buckets.
4887 &quot;bucketName&quot;: &quot;A String&quot;, # Cloud Storage bucket name.
4888 &quot;cdnPolicy&quot;: { # Message containing Cloud CDN configuration for a backend bucket. # Cloud CDN configuration for this BackendBucket.
4889 &quot;bypassCacheOnRequestHeaders&quot;: [ # Bypass the cache when the specified request headers are matched - e.g.
4890 # Pragma or Authorization headers. Up to 5 headers can be specified.
4891 # The cache is bypassed for all cdnPolicy.cacheMode settings.
4892 { # Bypass the cache when the specified request headers are present,
4893 # e.g. Pragma or Authorization headers. Values are case insensitive.
4894 # The presence of such a header overrides the cache_mode setting.
4895 &quot;headerName&quot;: &quot;A String&quot;, # The header field name to match on when bypassing cache.
4896 # Values are case-insensitive.
4897 },
4898 ],
4899 &quot;cacheKeyPolicy&quot;: { # Message containing what to include in the cache key for a request for # The CacheKeyPolicy for this CdnPolicy.
4900 # Cloud CDN.
4901 &quot;includeHttpHeaders&quot;: [ # Allows HTTP request headers (by name) to be used in the cache key.
4902 &quot;A String&quot;,
4903 ],
4904 &quot;queryStringWhitelist&quot;: [ # Names of query string parameters to include in cache keys. Default
4905 # parameters are always included. &#x27;&amp;&#x27; and &#x27;=&#x27; will be percent encoded
4906 # and not treated as delimiters.
4907 &quot;A String&quot;,
4908 ],
4909 },
4910 &quot;cacheMode&quot;: &quot;A String&quot;, # Specifies the cache setting for all responses from this backend.
4911 # The possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching
4912 # headers to cache content. Responses without these headers will not be
4913 # cached at Google&#x27;s edge, and will require a full trip to the origin on
4914 # every request, potentially impacting performance and increasing load on
4915 # the origin server.FORCE_CACHE_ALL Cache all content, ignoring any &quot;private&quot;,
4916 # &quot;no-store&quot; or &quot;no-cache&quot; directives in Cache-Control response headers.
4917 # Warning: this may result in Cloud CDN caching private,
4918 # per-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,
4919 # including common image formats, media (video and audio), and web assets
4920 # (JavaScript and CSS). Requests and responses that are marked as
4921 # uncacheable, as well as dynamic content (including HTML), will not be
4922 # cached.
4923 #
4924 # If no value is provided for cdnPolicy.cacheMode, it defaults
4925 # to CACHE_ALL_STATIC.
4926 &quot;clientTtl&quot;: 42, # Specifies a separate client (e.g. browser client) maximum TTL. This is
4927 # used to clamp the max-age (or Expires) value sent to the client. With
4928 # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the
4929 # response max-age directive, along with a &quot;public&quot; directive. For
4930 # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age
4931 # from the origin (if specified), or else sets the response max-age
4932 # directive to the lesser of the client_ttl and default_ttl, and also
4933 # ensures a &quot;public&quot; cache-control directive is present.
4934 # If a client TTL is not specified, a default value (1 hour) will be used.
4935 # The maximum allowed value is 31,622,400s (1 year).
4936 &quot;defaultTtl&quot;: 42, # Specifies the default TTL for cached content served by this origin for
4937 # responses that do not have an existing valid TTL (max-age or s-maxage).
4938 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
4939 # The value of defaultTTL cannot be set to a value greater than that of
4940 # maxTTL, but can be equal.
4941 # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL
4942 # will overwrite the TTL set in all responses. The maximum allowed value is
4943 # 31,622,400s (1 year), noting that infrequently accessed objects may be
4944 # evicted from the cache before the defined TTL.
4945 &quot;maxTtl&quot;: 42, # Specifies the maximum allowed TTL for cached content served by this
4946 # origin.
4947 # Cache directives that attempt to set a max-age or s-maxage higher than
4948 # this, or an Expires header more than maxTTL seconds in the future will
4949 # be capped at the value of maxTTL, as if it were the value of an
4950 # s-maxage Cache-Control directive.
4951 # Headers sent to the client will not be modified.
4952 # Setting a TTL of &quot;0&quot; means &quot;always revalidate&quot;.
4953 # The maximum allowed value is 31,622,400s (1 year), noting that
4954 # infrequently accessed objects may be evicted from the cache before
4955 # the defined TTL.
4956 &quot;negativeCaching&quot;: True or False, # Negative caching allows per-status code TTLs to be set, in order
4957 # to apply fine-grained caching for common errors or redirects.
4958 # This can reduce the load on your origin and improve end-user
4959 # experience by reducing response latency.
4960 # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,
4961 # negative caching applies to responses with the specified response code
4962 # that lack any Cache-Control, Expires, or Pragma: no-cache directives.
4963 # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies
4964 # to all responses with the specified response code, and override any
4965 # caching headers.
4966 # By default, Cloud CDN will apply the following default TTLs to these
4967 # status codes:
4968 # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m
4969 # HTTP 404 (Not Found), 410 (Gone),
4970 # 451 (Unavailable For Legal Reasons): 120s
4971 # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s.
4972 # These defaults can be overridden in negative_caching_policy.
4973 &quot;negativeCachingPolicy&quot;: [ # Sets a cache TTL for the specified HTTP status code.
4974 # negative_caching must be enabled to configure negative_caching_policy.
4975 # Omitting the policy and leaving negative_caching enabled will use
4976 # Cloud CDN&#x27;s default cache TTLs.
4977 # Note that when specifying an explicit negative_caching_policy, you
4978 # should take care to specify a cache TTL for all response codes
4979 # that you wish to cache. Cloud CDN will not apply any default
4980 # negative caching when a policy exists.
4981 { # Specify CDN TTLs for response error codes.
4982 &quot;code&quot;: 42, # The HTTP status code to define a TTL against. Only HTTP status codes
4983 # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
4984 # specified as values, and you cannot specify a status code more than
4985 # once.
4986 &quot;ttl&quot;: 42, # The TTL (in seconds) for which to cache responses with the
4987 # corresponding status code.
4988 # The maximum allowed value is 1800s (30 minutes), noting that
4989 # infrequently accessed objects may be evicted from the cache before the
4990 # defined TTL.
4991 },
4992 ],
4993 &quot;requestCoalescing&quot;: True or False, # If true then Cloud CDN will combine multiple concurrent cache fill
4994 # requests into a small number of requests to the origin.
4995 &quot;serveWhileStale&quot;: 42, # Serve existing content from the cache (if available) when revalidating
4996 # content with the origin, or when an error is encountered when refreshing
4997 # the cache.
4998 # This setting defines the default &quot;max-stale&quot; duration for any cached
4999 # responses that do not specify a max-stale directive. Stale responses that
5000 # exceed the TTL configured here will not be served. The default limit
5001 # (max-stale) is 86400s (1 day), which will allow stale content to be
5002 # served up to this limit beyond the max-age (or s-maxage) of a cached
5003 # response.
5004 # The maximum allowed value is 604800 (1 week).
5005 # Set this to zero (0) to disable serve-while-stale.
5006 &quot;signedUrlCacheMaxAgeSec&quot;: &quot;A String&quot;, # Maximum number of seconds the response to a signed URL request will be
5007 # considered fresh. After this time period, the response will be
5008 # revalidated before being served. Defaults to 1hr (3600s). When serving
5009 # responses to signed URL requests, Cloud CDN will internally behave as
5010 # though all responses from this backend had a &quot;Cache-Control:
5011 # public, max-age=[TTL]&quot; header, regardless of any existing
5012 # Cache-Control header. The actual headers served in responses will not be
5013 # altered.
5014 &quot;signedUrlKeyNames&quot;: [ # [Output Only] Names of the keys for signing request URLs.
5015 &quot;A String&quot;,
5016 ],
5017 },
5018 &quot;compressionMode&quot;: &quot;A String&quot;, # Compress text responses using Brotli or gzip compression, based on
5019 # the client&#x27;s Accept-Encoding header.
5020 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
5021 # text format.
5022 &quot;customResponseHeaders&quot;: [ # Headers that the Application Load Balancer should add to proxied responses.
5023 &quot;A String&quot;,
5024 ],
5025 &quot;description&quot;: &quot;A String&quot;, # An optional textual description of the resource; provided by the client
5026 # when the resource is created.
5027 &quot;edgeSecurityPolicy&quot;: &quot;A String&quot;, # [Output Only] The resource URL for the edge security policy associated with
5028 # this backend bucket.
5029 &quot;enableCdn&quot;: True or False, # If true, enable Cloud CDN for this BackendBucket.
5030 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
5031 &quot;kind&quot;: &quot;compute#backendBucket&quot;, # Output only. Type of the resource.
5032 &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # The value can only be INTERNAL_MANAGED for cross-region internal layer 7
5033 # load balancer.
5034 #
5035 # If loadBalancingScheme is not specified, the backend bucket can be used by
5036 # classic global external load balancers, or global application external load
5037 # balancers, or both.
5038 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
5039 # The name must be 1-63 characters long, and comply withRFC1035.
5040 # Specifically, the name must be 1-63 characters long and match the regular
5041 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
5042 # character must be a lowercase letter, and all following characters must
5043 # be a dash, lowercase letter, or digit, except the last character, which
5044 # cannot be a dash.
5045 &quot;params&quot;: { # Additional Backend Bucket parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
5046 # as part of resource payload.
5047 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
5048 # Tag keys and values have the same definition as resource
5049 # manager tags. The field is allowed for INSERT
5050 # only. The keys/values to set on the resource should be specified in
5051 # either ID { : } or Namespaced format
5052 # { : }.
5053 # For example the following are valid inputs:
5054 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
5055 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
5056 # Note:
5057 # * Invalid combinations of ID &amp; namespaced format is not supported. For
5058 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
5059 &quot;a_key&quot;: &quot;A String&quot;,
5060 },
5061 },
5062 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional backend bucket
5063 # resides. This field is not applicable to global backend buckets.
5064 # You must specify this field as part of the HTTP request URL. It is
5065 # not settable as a field in the request body.
5066 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5067 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
5068 &quot;usedBy&quot;: [ # Output only. [Output Only] List of resources referencing that backend bucket.
5069 {
5070 &quot;reference&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for UrlMaps referencing that
5071 # BackendBucket.
5072 },
5073 ],
5074 }
5075
5076 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
5077 that if you must retry your request, the server will know to ignore the
5078 request if it has already been completed.
5079
5080 For example, consider a situation where you make an initial request and
5081 the request times out. If you make the request again with the same
5082 request ID, the server can check if original operation with the same
5083 request ID was received, and if so, will ignore the second request. This
5084 prevents clients from accidentally creating duplicate commitments.
5085
5086 The request ID must be
5087 a valid UUID with the exception that zero UUID is not supported
5088 (00000000-0000-0000-0000-000000000000).
5089 x__xgafv: string, V1 error format.
5090 Allowed values
5091 1 - v1 error format
5092 2 - v2 error format
5093
5094 Returns:
5095 An object of the form:
5096
5097 { # Represents an Operation resource.
5098 #
5099 # Google Compute Engine has three Operation resources:
5100 #
5101 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
5102 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
5103 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
5104 #
5105 # You can use an operation resource to manage asynchronous API requests.
5106 # For more information, readHandling
5107 # API responses.
5108 #
5109 # Operations can be global, regional or zonal.
5110 #
5111 # - For global operations, use the `globalOperations`
5112 # resource.
5113 # - For regional operations, use the
5114 # `regionOperations` resource.
5115 # - For zonal operations, use
5116 # the `zoneOperations` resource.
5117 #
5118 #
5119 #
5120 # For more information, read
5121 # Global, Regional, and Zonal Resources.
5122 #
5123 # Note that completed Operation resources have a limited
5124 # retention period.
5125 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
5126 # Not present otherwise.
5127 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5128 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
5129 # set when the operation is created.
5130 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
5131 # text format.
5132 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
5133 # this field will be populated.
5134 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
5135 # operation.
5136 {
5137 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5138 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
5139 # details. There is a set of defined message types to use for providing
5140 # details.The syntax depends on the error code. For example,
5141 # QuotaExceededInfo will have details when the error code is
5142 # QUOTA_EXCEEDED.
5143 {
5144 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
5145 #
5146 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
5147 # is not enabled:
5148 #
5149 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
5150 # &quot;domain&quot;: &quot;googleapis.com&quot;
5151 # &quot;metadata&quot;: {
5152 # &quot;resource&quot;: &quot;projects/123&quot;,
5153 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
5154 # }
5155 # }
5156 #
5157 # This response indicates that the pubsub.googleapis.com API is not enabled.
5158 #
5159 # Example of an error that is returned when attempting to create a Spanner
5160 # instance in a region that is out of stock:
5161 #
5162 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
5163 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
5164 # &quot;metadata&quot;: {
5165 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
5166 # }
5167 # }
5168 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
5169 # is typically the registered service name of the tool or product that
5170 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
5171 # generated by some common infrastructure, the error domain must be a
5172 # globally unique value that identifies the infrastructure. For Google API
5173 # infrastructure, the error domain is &quot;googleapis.com&quot;.
5174 &quot;metadatas&quot;: { # Additional structured details about this error.
5175 #
5176 # Keys must match a regular expression of `a-z+` but should
5177 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
5178 # length. When identifying the current value of an exceeded limit, the units
5179 # should be contained in the key, not the value. For example, rather than
5180 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
5181 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
5182 # instances that can be created in a single (batch) request.
5183 &quot;a_key&quot;: &quot;A String&quot;,
5184 },
5185 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
5186 # proximate cause of the error. Error reasons are unique within a particular
5187 # domain of errors. This should be at most 63 characters and match a
5188 # regular expression of `A-Z+[A-Z0-9]`, which represents
5189 # UPPER_SNAKE_CASE.
5190 },
5191 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
5192 #
5193 # For example, if a quota check failed with an error indicating the calling
5194 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
5195 # directly to the right place in the developer console to flip the bit.
5196 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
5197 { # Describes a URL link.
5198 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
5199 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
5200 },
5201 ],
5202 },
5203 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
5204 # which can be attached to an RPC error.
5205 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
5206 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
5207 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
5208 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
5209 },
5210 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
5211 &quot;dimensions&quot;: { # The map holding related quota dimensions.
5212 &quot;a_key&quot;: &quot;A String&quot;,
5213 },
5214 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
5215 # type or metric.
5216 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
5217 # or metric.
5218 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
5219 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
5220 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
5221 },
5222 },
5223 ],
5224 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
5225 # This property is optional.
5226 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
5227 },
5228 ],
5229 },
5230 &quot;getVersionOperationMetadata&quot;: {
5231 &quot;inlineSbomInfo&quot;: {
5232 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
5233 # appropriate identifiers.
5234 &quot;a_key&quot;: &quot;A String&quot;,
5235 },
5236 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
5237 # identifiers.
5238 &quot;a_key&quot;: &quot;A String&quot;,
5239 },
5240 },
5241 },
5242 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
5243 # message that was returned, such as `NOT FOUND`.
5244 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
5245 # status code that was returned. For example, a `404` means the
5246 # resource was not found.
5247 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
5248 # defined by the server.
5249 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
5250 # This value is inRFC3339
5251 # text format.
5252 &quot;instancesBulkInsertOperationMetadata&quot;: {
5253 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
5254 # Example key: zones/us-central1-a
5255 &quot;a_key&quot;: {
5256 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
5257 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
5258 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
5259 # error.
5260 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
5261 # if the flow is rolling forward or rolling back.
5262 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
5263 },
5264 },
5265 },
5266 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
5267 # Operation resources.
5268 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
5269 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
5270 # group of operations results from a `bulkInsert` API request.
5271 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
5272 # `update`, or `delete`, and so on.
5273 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
5274 # There is no requirement that this be linear or support any granularity of
5275 # operations. This should not be used to guess when the operation will be
5276 # complete. This number should monotonically increase as the operation
5277 # progresses.
5278 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
5279 # applicable when performing regional operations.
5280 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5281 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
5282 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
5283 # this field will contain information on all underlying zonal actions and
5284 # their state.
5285 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
5286 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
5287 # Example key: zones/us-central1-a
5288 &quot;a_key&quot;: {
5289 &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
5290 # populated.
5291 # different programming environments, including REST APIs and RPC APIs. It is
5292 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
5293 # three pieces of data: error code, error message, and error details.
5294 #
5295 # You can find out more about this error model and how to work with it in the
5296 # [API Design Guide](https://cloud.google.com/apis/design/errors).
5297 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
5298 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
5299 # message types for APIs to use.
5300 {
5301 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
5302 },
5303 ],
5304 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
5305 # user-facing error message should be localized and sent in the
5306 # google.rpc.Status.details field, or localized by the client.
5307 },
5308 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
5309 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
5310 },
5311 },
5312 },
5313 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
5314 # This value is inRFC3339
5315 # text format.
5316 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
5317 # following:
5318 # `PENDING`, `RUNNING`, or `DONE`.
5319 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
5320 # operation.
5321 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
5322 # of the target resource.
5323 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
5324 # operations related to creating a snapshot, this points to the disk
5325 # that the snapshot was created from.
5326 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
5327 # `[email protected]` or
5328 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
5329 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
5330 # operation, this field will be populated.
5331 {
5332 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5333 # Engine returns NO_RESULTS_ON_PAGE if there
5334 # are no results in the response.
5335 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5336 # value format. For example:
5337 #
5338 # &quot;data&quot;: [
5339 # {
5340 # &quot;key&quot;: &quot;scope&quot;,
5341 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5342 # }
5343 {
5344 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5345 # returned. For example, for warnings where there are no results in a list
5346 # request for a particular zone, this key might be scope and
5347 # the key value might be the zone name. Other examples might be a key
5348 # indicating a deprecated resource and a suggested replacement, or a
5349 # warning about invalid network settings (for example, if an instance
5350 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5351 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5352 },
5353 ],
5354 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5355 },
5356 ],
5357 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
5358 # applicable when performing per-zone operations.
5359 }</pre>
5360 </div>
5361
5362 </body></html>