Debian Codegraph @

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