Debian Codegraph @

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