Debian Codegraph @

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