Debian Codegraph @

docs/dyn/compute_alpha.snapshotGroups.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.snapshotGroups.html">snapshotGroups</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#delete">delete(project, snapshotGroup, requestId=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Deletes the specified SnapshotGroup resource</p>
83 <p class="toc_element">
84 <code><a href="#get">get(project, snapshotGroup, x__xgafv=None)</a></code></p>
85 <p class="firstline">returns the specified SnapshotGroup resource.</p>
86 <p class="toc_element">
87 <code><a href="#getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Gets the access control policy for a resource. May be empty if no such</p>
89 <p class="toc_element">
90 <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Creates a snapshot group in the specified project using the data included</p>
92 <p class="toc_element">
93 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">retrieves the list of SnapshotGroup resources contained within</p>
95 <p class="toc_element">
96 <code><a href="#list_next">list_next()</a></code></p>
97 <p class="firstline">Retrieves the next page of results.</p>
98 <p class="toc_element">
99 <code><a href="#setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Sets the access control policy on the specified resource.</p>
101 <p class="toc_element">
102 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
104 <h3>Method Details</h3>
105 <div class="method">
106 <code class="details" id="close">close()</code>
107 <pre>Close httplib2 connections.</pre>
108 </div>
109
110 <div class="method">
111 <code class="details" id="delete">delete(project, snapshotGroup, requestId=None, x__xgafv=None)</code>
112 <pre>Deletes the specified SnapshotGroup resource
113
114 Args:
115 project: string, Project ID for this request. (required)
116 snapshotGroup: string, Name of the SnapshotGroup resource to delete. (required)
117 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
118 that if you must retry your request, the server will know to ignore the
119 request if it has already been completed.
120
121 For example, consider a situation where you make an initial request and
122 the request times out. If you make the request again with the same
123 request ID, the server can check if original operation with the same
124 request ID was received, and if so, will ignore the second request. This
125 prevents clients from accidentally creating duplicate commitments.
126
127 The request ID must be
128 a valid UUID with the exception that zero UUID is not supported
129 (00000000-0000-0000-0000-000000000000).
130 x__xgafv: string, V1 error format.
131 Allowed values
132 1 - v1 error format
133 2 - v2 error format
134
135 Returns:
136 An object of the form:
137
138 { # Represents an Operation resource.
139 #
140 # Google Compute Engine has three Operation resources:
141 #
142 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
143 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
144 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
145 #
146 # You can use an operation resource to manage asynchronous API requests.
147 # For more information, readHandling
148 # API responses.
149 #
150 # Operations can be global, regional or zonal.
151 #
152 # - For global operations, use the `globalOperations`
153 # resource.
154 # - For regional operations, use the
155 # `regionOperations` resource.
156 # - For zonal operations, use
157 # the `zoneOperations` resource.
158 #
159 #
160 #
161 # For more information, read
162 # Global, Regional, and Zonal Resources.
163 #
164 # Note that completed Operation resources have a limited
165 # retention period.
166 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
167 # Not present otherwise.
168 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
169 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
170 # set when the operation is created.
171 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
172 # text format.
173 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
174 # this field will be populated.
175 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
176 # operation.
177 {
178 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
179 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
180 # details. There is a set of defined message types to use for providing
181 # details.The syntax depends on the error code. For example,
182 # QuotaExceededInfo will have details when the error code is
183 # QUOTA_EXCEEDED.
184 {
185 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
186 #
187 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
188 # is not enabled:
189 #
190 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
191 # &quot;domain&quot;: &quot;googleapis.com&quot;
192 # &quot;metadata&quot;: {
193 # &quot;resource&quot;: &quot;projects/123&quot;,
194 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
195 # }
196 # }
197 #
198 # This response indicates that the pubsub.googleapis.com API is not enabled.
199 #
200 # Example of an error that is returned when attempting to create a Spanner
201 # instance in a region that is out of stock:
202 #
203 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
204 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
205 # &quot;metadata&quot;: {
206 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
207 # }
208 # }
209 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
210 # is typically the registered service name of the tool or product that
211 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
212 # generated by some common infrastructure, the error domain must be a
213 # globally unique value that identifies the infrastructure. For Google API
214 # infrastructure, the error domain is &quot;googleapis.com&quot;.
215 &quot;metadatas&quot;: { # Additional structured details about this error.
216 #
217 # Keys must match a regular expression of `a-z+` but should
218 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
219 # length. When identifying the current value of an exceeded limit, the units
220 # should be contained in the key, not the value. For example, rather than
221 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
222 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
223 # instances that can be created in a single (batch) request.
224 &quot;a_key&quot;: &quot;A String&quot;,
225 },
226 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
227 # proximate cause of the error. Error reasons are unique within a particular
228 # domain of errors. This should be at most 63 characters and match a
229 # regular expression of `A-Z+[A-Z0-9]`, which represents
230 # UPPER_SNAKE_CASE.
231 },
232 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
233 #
234 # For example, if a quota check failed with an error indicating the calling
235 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
236 # directly to the right place in the developer console to flip the bit.
237 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
238 { # Describes a URL link.
239 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
240 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
241 },
242 ],
243 },
244 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
245 # which can be attached to an RPC error.
246 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
247 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
248 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
249 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
250 },
251 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
252 &quot;dimensions&quot;: { # The map holding related quota dimensions.
253 &quot;a_key&quot;: &quot;A String&quot;,
254 },
255 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
256 # type or metric.
257 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
258 # or metric.
259 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
260 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
261 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
262 },
263 },
264 ],
265 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
266 # This property is optional.
267 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
268 },
269 ],
270 },
271 &quot;getVersionOperationMetadata&quot;: {
272 &quot;inlineSbomInfo&quot;: {
273 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
274 # appropriate identifiers.
275 &quot;a_key&quot;: &quot;A String&quot;,
276 },
277 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
278 # identifiers.
279 &quot;a_key&quot;: &quot;A String&quot;,
280 },
281 },
282 },
283 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
284 # message that was returned, such as `NOT FOUND`.
285 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
286 # status code that was returned. For example, a `404` means the
287 # resource was not found.
288 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
289 # defined by the server.
290 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
291 # This value is inRFC3339
292 # text format.
293 &quot;instancesBulkInsertOperationMetadata&quot;: {
294 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
295 # Example key: zones/us-central1-a
296 &quot;a_key&quot;: {
297 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
298 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
299 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
300 # error.
301 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
302 # if the flow is rolling forward or rolling back.
303 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
304 },
305 },
306 },
307 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
308 # Operation resources.
309 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
310 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
311 # group of operations results from a `bulkInsert` API request.
312 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
313 # `update`, or `delete`, and so on.
314 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
315 # There is no requirement that this be linear or support any granularity of
316 # operations. This should not be used to guess when the operation will be
317 # complete. This number should monotonically increase as the operation
318 # progresses.
319 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
320 # applicable when performing regional operations.
321 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
322 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
323 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
324 # this field will contain information on all underlying zonal actions and
325 # their state.
326 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
327 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
328 # Example key: zones/us-central1-a
329 &quot;a_key&quot;: {
330 &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
331 # populated.
332 # different programming environments, including REST APIs and RPC APIs. It is
333 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
334 # three pieces of data: error code, error message, and error details.
335 #
336 # You can find out more about this error model and how to work with it in the
337 # [API Design Guide](https://cloud.google.com/apis/design/errors).
338 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
339 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
340 # message types for APIs to use.
341 {
342 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
343 },
344 ],
345 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
346 # user-facing error message should be localized and sent in the
347 # google.rpc.Status.details field, or localized by the client.
348 },
349 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
350 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
351 },
352 },
353 },
354 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
355 # This value is inRFC3339
356 # text format.
357 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
358 # following:
359 # `PENDING`, `RUNNING`, or `DONE`.
360 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
361 # operation.
362 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
363 # of the target resource.
364 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
365 # operations related to creating a snapshot, this points to the disk
366 # that the snapshot was created from.
367 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
368 # `[email protected]` or
369 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
370 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
371 # operation, this field will be populated.
372 {
373 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
374 # Engine returns NO_RESULTS_ON_PAGE if there
375 # are no results in the response.
376 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
377 # value format. For example:
378 #
379 # &quot;data&quot;: [
380 # {
381 # &quot;key&quot;: &quot;scope&quot;,
382 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
383 # }
384 {
385 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
386 # returned. For example, for warnings where there are no results in a list
387 # request for a particular zone, this key might be scope and
388 # the key value might be the zone name. Other examples might be a key
389 # indicating a deprecated resource and a suggested replacement, or a
390 # warning about invalid network settings (for example, if an instance
391 # attempts to perform IP forwarding but is not enabled for IP forwarding).
392 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
393 },
394 ],
395 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
396 },
397 ],
398 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
399 # applicable when performing per-zone operations.
400 }</pre>
401 </div>
402
403 <div class="method">
404 <code class="details" id="get">get(project, snapshotGroup, x__xgafv=None)</code>
405 <pre>returns the specified SnapshotGroup resource.
406
407 Args:
408 project: string, Project ID for this request. (required)
409 snapshotGroup: string, Name of the SnapshotGroup resource to return. (required)
410 x__xgafv: string, V1 error format.
411 Allowed values
412 1 - v1 error format
413 2 - v2 error format
414
415 Returns:
416 An object of the form:
417
418 { # Represents a SnapshotGroup resource.
419 #
420 # A snapshot group is a set of snapshots that represents a point in time state
421 # of a consistency group.
422 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
423 # text format.
424 &quot;description&quot;: &quot;A String&quot;, # Optional. An optional description of this resource. Provide this property when you
425 # create the resource.
426 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
427 # defined by the server.
428 &quot;kind&quot;: &quot;compute#snapshotGroup&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#snapshotGroup for SnapshotGroup
429 # resources.
430 &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the resource; provided by the client when the resource is created.
431 # The name must be 1-63 characters long, and comply withRFC1035.
432 # Specifically, the name must be 1-63 characters long and match the regular
433 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
434 # character must be a lowercase letter, and all following characters must be
435 # a dash, lowercase letter, or digit, except the last character, which cannot
436 # be a dash.
437 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
438 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource&#x27;s resource id.
439 &quot;sourceInfo&quot;: { # Output only. [Output Only]
440 &quot;consistencyGroup&quot;: &quot;A String&quot;,
441 &quot;consistencyGroupId&quot;: &quot;A String&quot;,
442 },
443 &quot;sourceInstantSnapshotGroup&quot;: &quot;A String&quot;, # Input field for the source instant snapshot group.
444 &quot;sourceInstantSnapshotGroupInfo&quot;: { # Output only. [Output Only]
445 &quot;instantSnapshotGroup&quot;: &quot;A String&quot;,
446 &quot;instantSnapshotGroupId&quot;: &quot;A String&quot;,
447 },
448 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only]
449 }</pre>
450 </div>
451
452 <div class="method">
453 <code class="details" id="getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
454 <pre>Gets the access control policy for a resource. May be empty if no such
455 policy or resource exists.
456
457 Args:
458 project: string, Project ID for this request. (required)
459 resource: string, Name or id of the resource for this request. (required)
460 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
461 x__xgafv: string, V1 error format.
462 Allowed values
463 1 - v1 error format
464 2 - v2 error format
465
466 Returns:
467 An object of the form:
468
469 { # An Identity and Access Management (IAM) policy, which specifies access
470 # controls for Google Cloud resources.
471 #
472 #
473 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
474 # `members`, or principals, to a single `role`. Principals can be user
475 # accounts, service accounts, Google groups, and domains (such as G Suite). A
476 # `role` is a named list of permissions; each `role` can be an IAM predefined
477 # role or a user-created custom role.
478 #
479 # For some types of Google Cloud resources, a `binding` can also specify a
480 # `condition`, which is a logical expression that allows access to a resource
481 # only if the expression evaluates to `true`. A condition can add constraints
482 # based on attributes of the request, the resource, or both. To learn which
483 # resources support conditions in their IAM policies, see the
484 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
485 #
486 # **JSON example:**
487 #
488 # ```
489 # {
490 # &quot;bindings&quot;: [
491 # {
492 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
493 # &quot;members&quot;: [
494 # &quot;user:[email protected]&quot;,
495 # &quot;group:[email protected]&quot;,
496 # &quot;domain:google.com&quot;,
497 # &quot;serviceAccount:[email protected]&quot;
498 # ]
499 # },
500 # {
501 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
502 # &quot;members&quot;: [
503 # &quot;user:[email protected]&quot;
504 # ],
505 # &quot;condition&quot;: {
506 # &quot;title&quot;: &quot;expirable access&quot;,
507 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
508 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
509 # }
510 # }
511 # ],
512 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
513 # &quot;version&quot;: 3
514 # }
515 # ```
516 #
517 # **YAML example:**
518 #
519 # ```
520 # bindings:
521 # - members:
522 # - user:[email protected]
523 # - group:[email protected]
524 # - domain:google.com
525 # - serviceAccount:[email protected]
526 # role: roles/resourcemanager.organizationAdmin
527 # - members:
528 # - user:[email protected]
529 # role: roles/resourcemanager.organizationViewer
530 # condition:
531 # title: expirable access
532 # description: Does not grant access after Sep 2020
533 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
534 # etag: BwWWja0YfJA=
535 # version: 3
536 # ```
537 #
538 # For a description of IAM and its features, see the
539 # [IAM documentation](https://cloud.google.com/iam/docs/).
540 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
541 { # Specifies the audit configuration for a service.
542 # The configuration determines which permission types are logged, and what
543 # identities, if any, are exempted from logging.
544 # An AuditConfig must have one or more AuditLogConfigs.
545 #
546 # If there are AuditConfigs for both `allServices` and a specific service,
547 # the union of the two AuditConfigs is used for that service: the log_types
548 # specified in each AuditConfig are enabled, and the exempted_members in each
549 # AuditLogConfig are exempted.
550 #
551 # Example Policy with multiple AuditConfigs:
552 #
553 # {
554 # &quot;audit_configs&quot;: [
555 # {
556 # &quot;service&quot;: &quot;allServices&quot;,
557 # &quot;audit_log_configs&quot;: [
558 # {
559 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
560 # &quot;exempted_members&quot;: [
561 # &quot;user:[email protected]&quot;
562 # ]
563 # },
564 # {
565 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
566 # },
567 # {
568 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
569 # }
570 # ]
571 # },
572 # {
573 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
574 # &quot;audit_log_configs&quot;: [
575 # {
576 # &quot;log_type&quot;: &quot;DATA_READ&quot;
577 # },
578 # {
579 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
580 # &quot;exempted_members&quot;: [
581 # &quot;user:[email protected]&quot;
582 # ]
583 # }
584 # ]
585 # }
586 # ]
587 # }
588 #
589 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
590 # logging. It also exempts `[email protected]` from DATA_READ logging, and
591 # `[email protected]` from DATA_WRITE logging.
592 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
593 { # Provides the configuration for logging a type of permissions.
594 # Example:
595 #
596 # {
597 # &quot;audit_log_configs&quot;: [
598 # {
599 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
600 # &quot;exempted_members&quot;: [
601 # &quot;user:[email protected]&quot;
602 # ]
603 # },
604 # {
605 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
606 # }
607 # ]
608 # }
609 #
610 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
611 # [email protected] from DATA_READ logging.
612 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
613 # permission.
614 # Follows the same format of Binding.members.
615 &quot;A String&quot;,
616 ],
617 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
618 },
619 ],
620 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
621 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
622 # `allServices` is a special value that covers all services.
623 },
624 ],
625 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
626 # may specify a `condition` that determines how and when the `bindings` are
627 # applied. Each of the `bindings` must contain at least one principal.
628 #
629 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
630 # of these principals can be Google groups. Each occurrence of a principal
631 # counts towards these limits. For example, if the `bindings` grant 50
632 # different roles to `user:[email protected]`, and not to any other
633 # principal, then you can add another 1,450 principals to the `bindings` in
634 # the `Policy`.
635 { # Associates `members`, or principals, with a `role`.
636 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
637 #
638 # If the condition evaluates to `true`, then this binding applies to the
639 # current request.
640 #
641 # If the condition evaluates to `false`, then this binding does not apply to
642 # the current request. However, a different role binding might grant the same
643 # role to one or more of the principals in this binding.
644 #
645 # To learn which resources support conditions in their IAM policies, see the
646 # [IAM
647 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
648 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
649 # are documented at https://github.com/google/cel-spec.
650 #
651 # Example (Comparison):
652 #
653 # title: &quot;Summary size limit&quot;
654 # description: &quot;Determines if a summary is less than 100 chars&quot;
655 # expression: &quot;document.summary.size() &lt; 100&quot;
656 #
657 # Example (Equality):
658 #
659 # title: &quot;Requestor is owner&quot;
660 # description: &quot;Determines if requestor is the document owner&quot;
661 # expression: &quot;document.owner == request.auth.claims.email&quot;
662 #
663 # Example (Logic):
664 #
665 # title: &quot;Public documents&quot;
666 # description: &quot;Determine whether the document should be publicly visible&quot;
667 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
668 #
669 # Example (Data Manipulation):
670 #
671 # title: &quot;Notification string&quot;
672 # description: &quot;Create a notification string with a timestamp.&quot;
673 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
674 #
675 # The exact variables and functions that may be referenced within an expression
676 # are determined by the service that evaluates it. See the service
677 # documentation for additional information.
678 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
679 # describes the expression, e.g. when hovered over it in a UI.
680 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
681 # syntax.
682 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
683 # reporting, e.g. a file name and a position in the file.
684 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
685 # its purpose. This can be used e.g. in UIs which allow to enter the
686 # expression.
687 },
688 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
689 # `members` can have the following values:
690 #
691 # * `allUsers`: A special identifier that represents anyone who is
692 # on the internet; with or without a Google account.
693 #
694 # * `allAuthenticatedUsers`: A special identifier that represents anyone
695 # who is authenticated with a Google account or a service account.
696 # Does not include identities that come from external identity providers
697 # (IdPs) through identity federation.
698 #
699 # * `user:{emailid}`: An email address that represents a specific Google
700 # account. For example, `[email protected]` .
701 #
702 #
703 # * `serviceAccount:{emailid}`: An email address that represents a Google
704 # service account. For example,
705 # `[email protected]`.
706 #
707 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
708 # identifier for a
709 # [Kubernetes service
710 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
711 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
712 #
713 # * `group:{emailid}`: An email address that represents a Google group.
714 # For example, `[email protected]`.
715 #
716 #
717 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
718 # users of that domain. For example, `google.com` or `example.com`.
719 #
720 #
721 #
722 #
723 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
724 # A single identity in a workforce identity pool.
725 #
726 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
727 # All workforce identities in a group.
728 #
729 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
730 # All workforce identities with a specific attribute value.
731 #
732 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
733 # All identities in a workforce identity pool.
734 #
735 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
736 # A single identity in a workload identity pool.
737 #
738 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
739 # A workload identity pool group.
740 #
741 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
742 # All identities in a workload identity pool with a certain attribute.
743 #
744 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
745 # All identities in a workload identity pool.
746 #
747 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
748 # identifier) representing a user that has been recently deleted. For
749 # example, `[email protected]?uid=123456789012345678901`. If the user is
750 # recovered, this value reverts to `user:{emailid}` and the recovered user
751 # retains the role in the binding.
752 #
753 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
754 # unique identifier) representing a service account that has been recently
755 # deleted. For example,
756 # `[email protected]?uid=123456789012345678901`.
757 # If the service account is undeleted, this value reverts to
758 # `serviceAccount:{emailid}` and the undeleted service account retains the
759 # role in the binding.
760 #
761 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
762 # identifier) representing a Google group that has been recently
763 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
764 # the group is recovered, this value reverts to `group:{emailid}` and the
765 # recovered group retains the role in the binding.
766 #
767 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
768 # Deleted single identity in a workforce identity pool. For example,
769 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
770 &quot;A String&quot;,
771 ],
772 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
773 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
774 #
775 # For an overview of the IAM roles and permissions, see the
776 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
777 # a list of the available pre-defined roles, see
778 # [here](https://cloud.google.com/iam/docs/understanding-roles).
779 },
780 ],
781 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
782 # prevent simultaneous updates of a policy from overwriting each other.
783 # It is strongly suggested that systems make use of the `etag` in the
784 # read-modify-write cycle to perform policy updates in order to avoid race
785 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
786 # systems are expected to put that etag in the request to `setIamPolicy` to
787 # ensure that their change will be applied to the same version of the policy.
788 #
789 # **Important:** If you use IAM Conditions, you must include the `etag` field
790 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
791 # you to overwrite a version `3` policy with a version `1` policy, and all of
792 # the conditions in the version `3` policy are lost.
793 &quot;version&quot;: 42, # Specifies the format of the policy.
794 #
795 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
796 # are rejected.
797 #
798 # Any operation that affects conditional role bindings must specify version
799 # `3`. This requirement applies to the following operations:
800 #
801 # * Getting a policy that includes a conditional role binding
802 # * Adding a conditional role binding to a policy
803 # * Changing a conditional role binding in a policy
804 # * Removing any role binding, with or without a condition, from a policy
805 # that includes conditions
806 #
807 # **Important:** If you use IAM Conditions, you must include the `etag` field
808 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
809 # you to overwrite a version `3` policy with a version `1` policy, and all of
810 # the conditions in the version `3` policy are lost.
811 #
812 # If a policy does not include any conditions, operations on that policy may
813 # specify any valid version or leave the field unset.
814 #
815 # To learn which resources support conditions in their IAM policies, see the
816 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
817 }</pre>
818 </div>
819
820 <div class="method">
821 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code>
822 <pre>Creates a snapshot group in the specified project using the data included
823 in the request.
824
825 Args:
826 project: string, Project ID for this request. (required)
827 body: object, The request body.
828 The object takes the form of:
829
830 { # Represents a SnapshotGroup resource.
831 #
832 # A snapshot group is a set of snapshots that represents a point in time state
833 # of a consistency group.
834 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
835 # text format.
836 &quot;description&quot;: &quot;A String&quot;, # Optional. An optional description of this resource. Provide this property when you
837 # create the resource.
838 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
839 # defined by the server.
840 &quot;kind&quot;: &quot;compute#snapshotGroup&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#snapshotGroup for SnapshotGroup
841 # resources.
842 &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the resource; provided by the client when the resource is created.
843 # The name must be 1-63 characters long, and comply withRFC1035.
844 # Specifically, the name must be 1-63 characters long and match the regular
845 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
846 # character must be a lowercase letter, and all following characters must be
847 # a dash, lowercase letter, or digit, except the last character, which cannot
848 # be a dash.
849 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
850 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource&#x27;s resource id.
851 &quot;sourceInfo&quot;: { # Output only. [Output Only]
852 &quot;consistencyGroup&quot;: &quot;A String&quot;,
853 &quot;consistencyGroupId&quot;: &quot;A String&quot;,
854 },
855 &quot;sourceInstantSnapshotGroup&quot;: &quot;A String&quot;, # Input field for the source instant snapshot group.
856 &quot;sourceInstantSnapshotGroupInfo&quot;: { # Output only. [Output Only]
857 &quot;instantSnapshotGroup&quot;: &quot;A String&quot;,
858 &quot;instantSnapshotGroupId&quot;: &quot;A String&quot;,
859 },
860 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only]
861 }
862
863 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
864 that if you must retry your request, the server will know to ignore the
865 request if it has already been completed.
866
867 For example, consider a situation where you make an initial request and
868 the request times out. If you make the request again with the same
869 request ID, the server can check if original operation with the same
870 request ID was received, and if so, will ignore the second request. This
871 prevents clients from accidentally creating duplicate commitments.
872
873 The request ID must be
874 a valid UUID with the exception that zero UUID is not supported
875 (00000000-0000-0000-0000-000000000000).
876 x__xgafv: string, V1 error format.
877 Allowed values
878 1 - v1 error format
879 2 - v2 error format
880
881 Returns:
882 An object of the form:
883
884 { # Represents an Operation resource.
885 #
886 # Google Compute Engine has three Operation resources:
887 #
888 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
889 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
890 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
891 #
892 # You can use an operation resource to manage asynchronous API requests.
893 # For more information, readHandling
894 # API responses.
895 #
896 # Operations can be global, regional or zonal.
897 #
898 # - For global operations, use the `globalOperations`
899 # resource.
900 # - For regional operations, use the
901 # `regionOperations` resource.
902 # - For zonal operations, use
903 # the `zoneOperations` resource.
904 #
905 #
906 #
907 # For more information, read
908 # Global, Regional, and Zonal Resources.
909 #
910 # Note that completed Operation resources have a limited
911 # retention period.
912 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
913 # Not present otherwise.
914 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
915 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
916 # set when the operation is created.
917 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
918 # text format.
919 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
920 # this field will be populated.
921 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
922 # operation.
923 {
924 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
925 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
926 # details. There is a set of defined message types to use for providing
927 # details.The syntax depends on the error code. For example,
928 # QuotaExceededInfo will have details when the error code is
929 # QUOTA_EXCEEDED.
930 {
931 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
932 #
933 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
934 # is not enabled:
935 #
936 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
937 # &quot;domain&quot;: &quot;googleapis.com&quot;
938 # &quot;metadata&quot;: {
939 # &quot;resource&quot;: &quot;projects/123&quot;,
940 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
941 # }
942 # }
943 #
944 # This response indicates that the pubsub.googleapis.com API is not enabled.
945 #
946 # Example of an error that is returned when attempting to create a Spanner
947 # instance in a region that is out of stock:
948 #
949 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
950 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
951 # &quot;metadata&quot;: {
952 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
953 # }
954 # }
955 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
956 # is typically the registered service name of the tool or product that
957 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
958 # generated by some common infrastructure, the error domain must be a
959 # globally unique value that identifies the infrastructure. For Google API
960 # infrastructure, the error domain is &quot;googleapis.com&quot;.
961 &quot;metadatas&quot;: { # Additional structured details about this error.
962 #
963 # Keys must match a regular expression of `a-z+` but should
964 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
965 # length. When identifying the current value of an exceeded limit, the units
966 # should be contained in the key, not the value. For example, rather than
967 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
968 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
969 # instances that can be created in a single (batch) request.
970 &quot;a_key&quot;: &quot;A String&quot;,
971 },
972 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
973 # proximate cause of the error. Error reasons are unique within a particular
974 # domain of errors. This should be at most 63 characters and match a
975 # regular expression of `A-Z+[A-Z0-9]`, which represents
976 # UPPER_SNAKE_CASE.
977 },
978 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
979 #
980 # For example, if a quota check failed with an error indicating the calling
981 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
982 # directly to the right place in the developer console to flip the bit.
983 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
984 { # Describes a URL link.
985 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
986 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
987 },
988 ],
989 },
990 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
991 # which can be attached to an RPC error.
992 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
993 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
994 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
995 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
996 },
997 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
998 &quot;dimensions&quot;: { # The map holding related quota dimensions.
999 &quot;a_key&quot;: &quot;A String&quot;,
1000 },
1001 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1002 # type or metric.
1003 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1004 # or metric.
1005 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1006 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1007 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1008 },
1009 },
1010 ],
1011 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1012 # This property is optional.
1013 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1014 },
1015 ],
1016 },
1017 &quot;getVersionOperationMetadata&quot;: {
1018 &quot;inlineSbomInfo&quot;: {
1019 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1020 # appropriate identifiers.
1021 &quot;a_key&quot;: &quot;A String&quot;,
1022 },
1023 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1024 # identifiers.
1025 &quot;a_key&quot;: &quot;A String&quot;,
1026 },
1027 },
1028 },
1029 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1030 # message that was returned, such as `NOT FOUND`.
1031 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1032 # status code that was returned. For example, a `404` means the
1033 # resource was not found.
1034 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1035 # defined by the server.
1036 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1037 # This value is inRFC3339
1038 # text format.
1039 &quot;instancesBulkInsertOperationMetadata&quot;: {
1040 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1041 # Example key: zones/us-central1-a
1042 &quot;a_key&quot;: {
1043 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1044 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1045 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1046 # error.
1047 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1048 # if the flow is rolling forward or rolling back.
1049 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1050 },
1051 },
1052 },
1053 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1054 # Operation resources.
1055 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1056 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1057 # group of operations results from a `bulkInsert` API request.
1058 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1059 # `update`, or `delete`, and so on.
1060 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1061 # There is no requirement that this be linear or support any granularity of
1062 # operations. This should not be used to guess when the operation will be
1063 # complete. This number should monotonically increase as the operation
1064 # progresses.
1065 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1066 # applicable when performing regional operations.
1067 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1068 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1069 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1070 # this field will contain information on all underlying zonal actions and
1071 # their state.
1072 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1073 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1074 # Example key: zones/us-central1-a
1075 &quot;a_key&quot;: {
1076 &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
1077 # populated.
1078 # different programming environments, including REST APIs and RPC APIs. It is
1079 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1080 # three pieces of data: error code, error message, and error details.
1081 #
1082 # You can find out more about this error model and how to work with it in the
1083 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1084 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1085 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1086 # message types for APIs to use.
1087 {
1088 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1089 },
1090 ],
1091 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1092 # user-facing error message should be localized and sent in the
1093 # google.rpc.Status.details field, or localized by the client.
1094 },
1095 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1096 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1097 },
1098 },
1099 },
1100 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1101 # This value is inRFC3339
1102 # text format.
1103 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1104 # following:
1105 # `PENDING`, `RUNNING`, or `DONE`.
1106 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1107 # operation.
1108 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1109 # of the target resource.
1110 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1111 # operations related to creating a snapshot, this points to the disk
1112 # that the snapshot was created from.
1113 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1114 # `[email protected]` or
1115 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1116 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1117 # operation, this field will be populated.
1118 {
1119 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1120 # Engine returns NO_RESULTS_ON_PAGE if there
1121 # are no results in the response.
1122 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1123 # value format. For example:
1124 #
1125 # &quot;data&quot;: [
1126 # {
1127 # &quot;key&quot;: &quot;scope&quot;,
1128 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1129 # }
1130 {
1131 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1132 # returned. For example, for warnings where there are no results in a list
1133 # request for a particular zone, this key might be scope and
1134 # the key value might be the zone name. Other examples might be a key
1135 # indicating a deprecated resource and a suggested replacement, or a
1136 # warning about invalid network settings (for example, if an instance
1137 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1138 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1139 },
1140 ],
1141 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1142 },
1143 ],
1144 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1145 # applicable when performing per-zone operations.
1146 }</pre>
1147 </div>
1148
1149 <div class="method">
1150 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
1151 <pre>retrieves the list of SnapshotGroup resources contained within
1152 the specified project.
1153
1154 Args:
1155 project: string, Project ID for this request. (required)
1156 filter: string, A filter expression that filters resources listed in the response. Most
1157 Compute resources support two types of filter expressions:
1158 expressions that support regular expressions and expressions that follow
1159 API improvement proposal AIP-160.
1160 These two types of filter expressions cannot be mixed in one request.
1161
1162 If you want to use AIP-160, your expression must specify the field name, an
1163 operator, and the value that you want to use for filtering. The value
1164 must be a string, a number, or a boolean. The operator
1165 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1166
1167 For example, if you are filtering Compute Engine instances, you can
1168 exclude instances named `example-instance` by specifying
1169 `name != example-instance`.
1170
1171 The `:*` comparison can be used to test whether a key has been defined.
1172 For example, to find all objects with `owner` label use:
1173 ```
1174 labels.owner:*
1175 ```
1176
1177 You can also filter nested fields. For example, you could specify
1178 `scheduling.automaticRestart = false` to include instances only
1179 if they are not scheduled for automatic restarts. You can use filtering
1180 on nested fields to filter based onresource labels.
1181
1182 To filter on multiple expressions, provide each separate expression within
1183 parentheses. For example:
1184 ```
1185 (scheduling.automaticRestart = true)
1186 (cpuPlatform = &quot;Intel Skylake&quot;)
1187 ```
1188 By default, each expression is an `AND` expression. However, you
1189 can include `AND` and `OR` expressions explicitly.
1190 For example:
1191 ```
1192 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1193 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1194 (scheduling.automaticRestart = true)
1195 ```
1196
1197 If you want to use a regular expression, use the `eq` (equal) or `ne`
1198 (not equal) operator against a single un-parenthesized expression with or
1199 without quotes or against multiple parenthesized expressions. Examples:
1200
1201 `fieldname eq unquoted literal`
1202 `fieldname eq &#x27;single quoted literal&#x27;`
1203 `fieldname eq &quot;double quoted literal&quot;`
1204 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1205
1206 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1207 The literal value must match the entire field.
1208
1209 For example, to filter for instances that do not end with name &quot;instance&quot;,
1210 you would use `name ne .*instance`.
1211
1212 You cannot combine constraints on multiple fields using regular
1213 expressions.
1214 maxResults: integer, The maximum number of results per page that should be returned.
1215 If the number of available results is larger than `maxResults`,
1216 Compute Engine returns a `nextPageToken` that can be used to get
1217 the next page of results in subsequent list requests. Acceptable values are
1218 `0` to `500`, inclusive. (Default: `500`)
1219 orderBy: string, Sorts list results by a certain order. By default, results
1220 are returned in alphanumerical order based on the resource name.
1221
1222 You can also sort results in descending order based on the creation
1223 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1224 results based on the `creationTimestamp` field in
1225 reverse chronological order (newest result first). Use this to sort
1226 resources like operations so that the newest operation is returned first.
1227
1228 Currently, only sorting by `name` or
1229 `creationTimestamp desc` is supported.
1230 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1231 `nextPageToken` returned by a previous list request to get
1232 the next page of results.
1233 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1234 of failure. The default value is false.
1235
1236 For example, when partial success behavior is enabled, aggregatedList for a
1237 single zone scope either returns all resources in the zone or no resources,
1238 with an error code.
1239 x__xgafv: string, V1 error format.
1240 Allowed values
1241 1 - v1 error format
1242 2 - v2 error format
1243
1244 Returns:
1245 An object of the form:
1246
1247 { # Contains a list of SnapshotGroup resources.
1248 &quot;etag&quot;: &quot;A String&quot;,
1249 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1250 &quot;items&quot;: [ # A list of SnapshotGroup resources.
1251 { # Represents a SnapshotGroup resource.
1252 #
1253 # A snapshot group is a set of snapshots that represents a point in time state
1254 # of a consistency group.
1255 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1256 # text format.
1257 &quot;description&quot;: &quot;A String&quot;, # Optional. An optional description of this resource. Provide this property when you
1258 # create the resource.
1259 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1260 # defined by the server.
1261 &quot;kind&quot;: &quot;compute#snapshotGroup&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#snapshotGroup for SnapshotGroup
1262 # resources.
1263 &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the resource; provided by the client when the resource is created.
1264 # The name must be 1-63 characters long, and comply withRFC1035.
1265 # Specifically, the name must be 1-63 characters long and match the regular
1266 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1267 # character must be a lowercase letter, and all following characters must be
1268 # a dash, lowercase letter, or digit, except the last character, which cannot
1269 # be a dash.
1270 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1271 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource&#x27;s resource id.
1272 &quot;sourceInfo&quot;: { # Output only. [Output Only]
1273 &quot;consistencyGroup&quot;: &quot;A String&quot;,
1274 &quot;consistencyGroupId&quot;: &quot;A String&quot;,
1275 },
1276 &quot;sourceInstantSnapshotGroup&quot;: &quot;A String&quot;, # Input field for the source instant snapshot group.
1277 &quot;sourceInstantSnapshotGroupInfo&quot;: { # Output only. [Output Only]
1278 &quot;instantSnapshotGroup&quot;: &quot;A String&quot;,
1279 &quot;instantSnapshotGroupId&quot;: &quot;A String&quot;,
1280 },
1281 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only]
1282 },
1283 ],
1284 &quot;kind&quot;: &quot;compute#snapshotGroupsList&quot;, # Output only. Type of resource.
1285 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
1286 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1287 # the query parameter pageToken in the next list request.
1288 # Subsequent list requests will have their own nextPageToken to
1289 # continue paging through the results.
1290 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
1291 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
1292 # end_interface: MixerListResponseWithEtagBuilder
1293 &quot;A String&quot;,
1294 ],
1295 &quot;warning&quot;: { # [Output Only] Informational warning message.
1296 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1297 # Engine returns NO_RESULTS_ON_PAGE if there
1298 # are no results in the response.
1299 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1300 # value format. For example:
1301 #
1302 # &quot;data&quot;: [
1303 # {
1304 # &quot;key&quot;: &quot;scope&quot;,
1305 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1306 # }
1307 {
1308 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1309 # returned. For example, for warnings where there are no results in a list
1310 # request for a particular zone, this key might be scope and
1311 # the key value might be the zone name. Other examples might be a key
1312 # indicating a deprecated resource and a suggested replacement, or a
1313 # warning about invalid network settings (for example, if an instance
1314 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1315 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1316 },
1317 ],
1318 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1319 },
1320 }</pre>
1321 </div>
1322
1323 <div class="method">
1324 <code class="details" id="list_next">list_next()</code>
1325 <pre>Retrieves the next page of results.
1326
1327 Args:
1328 previous_request: The request for the previous page. (required)
1329 previous_response: The response from the request for the previous page. (required)
1330
1331 Returns:
1332 A request object that you can call &#x27;execute()&#x27; on to request the next
1333 page. Returns None if there are no more items in the collection.
1334 </pre>
1335 </div>
1336
1337 <div class="method">
1338 <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</code>
1339 <pre>Sets the access control policy on the specified resource.
1340 Replaces any existing policy.
1341
1342 Args:
1343 project: string, Project ID for this request. (required)
1344 resource: string, Name or id of the resource for this request. (required)
1345 body: object, The request body.
1346 The object takes the form of:
1347
1348 {
1349 &quot;bindings&quot;: [ # Flatten Policy to create a backward compatible wire-format.
1350 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
1351 { # Associates `members`, or principals, with a `role`.
1352 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1353 #
1354 # If the condition evaluates to `true`, then this binding applies to the
1355 # current request.
1356 #
1357 # If the condition evaluates to `false`, then this binding does not apply to
1358 # the current request. However, a different role binding might grant the same
1359 # role to one or more of the principals in this binding.
1360 #
1361 # To learn which resources support conditions in their IAM policies, see the
1362 # [IAM
1363 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1364 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1365 # are documented at https://github.com/google/cel-spec.
1366 #
1367 # Example (Comparison):
1368 #
1369 # title: &quot;Summary size limit&quot;
1370 # description: &quot;Determines if a summary is less than 100 chars&quot;
1371 # expression: &quot;document.summary.size() &lt; 100&quot;
1372 #
1373 # Example (Equality):
1374 #
1375 # title: &quot;Requestor is owner&quot;
1376 # description: &quot;Determines if requestor is the document owner&quot;
1377 # expression: &quot;document.owner == request.auth.claims.email&quot;
1378 #
1379 # Example (Logic):
1380 #
1381 # title: &quot;Public documents&quot;
1382 # description: &quot;Determine whether the document should be publicly visible&quot;
1383 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
1384 #
1385 # Example (Data Manipulation):
1386 #
1387 # title: &quot;Notification string&quot;
1388 # description: &quot;Create a notification string with a timestamp.&quot;
1389 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
1390 #
1391 # The exact variables and functions that may be referenced within an expression
1392 # are determined by the service that evaluates it. See the service
1393 # documentation for additional information.
1394 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
1395 # describes the expression, e.g. when hovered over it in a UI.
1396 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
1397 # syntax.
1398 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
1399 # reporting, e.g. a file name and a position in the file.
1400 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
1401 # its purpose. This can be used e.g. in UIs which allow to enter the
1402 # expression.
1403 },
1404 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
1405 # `members` can have the following values:
1406 #
1407 # * `allUsers`: A special identifier that represents anyone who is
1408 # on the internet; with or without a Google account.
1409 #
1410 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1411 # who is authenticated with a Google account or a service account.
1412 # Does not include identities that come from external identity providers
1413 # (IdPs) through identity federation.
1414 #
1415 # * `user:{emailid}`: An email address that represents a specific Google
1416 # account. For example, `[email protected]` .
1417 #
1418 #
1419 # * `serviceAccount:{emailid}`: An email address that represents a Google
1420 # service account. For example,
1421 # `[email protected]`.
1422 #
1423 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
1424 # identifier for a
1425 # [Kubernetes service
1426 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
1427 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
1428 #
1429 # * `group:{emailid}`: An email address that represents a Google group.
1430 # For example, `[email protected]`.
1431 #
1432 #
1433 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1434 # users of that domain. For example, `google.com` or `example.com`.
1435 #
1436 #
1437 #
1438 #
1439 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1440 # A single identity in a workforce identity pool.
1441 #
1442 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
1443 # All workforce identities in a group.
1444 #
1445 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1446 # All workforce identities with a specific attribute value.
1447 #
1448 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
1449 # All identities in a workforce identity pool.
1450 #
1451 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
1452 # A single identity in a workload identity pool.
1453 #
1454 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
1455 # A workload identity pool group.
1456 #
1457 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1458 # All identities in a workload identity pool with a certain attribute.
1459 #
1460 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
1461 # All identities in a workload identity pool.
1462 #
1463 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1464 # identifier) representing a user that has been recently deleted. For
1465 # example, `[email protected]?uid=123456789012345678901`. If the user is
1466 # recovered, this value reverts to `user:{emailid}` and the recovered user
1467 # retains the role in the binding.
1468 #
1469 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1470 # unique identifier) representing a service account that has been recently
1471 # deleted. For example,
1472 # `[email protected]?uid=123456789012345678901`.
1473 # If the service account is undeleted, this value reverts to
1474 # `serviceAccount:{emailid}` and the undeleted service account retains the
1475 # role in the binding.
1476 #
1477 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1478 # identifier) representing a Google group that has been recently
1479 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
1480 # the group is recovered, this value reverts to `group:{emailid}` and the
1481 # recovered group retains the role in the binding.
1482 #
1483 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1484 # Deleted single identity in a workforce identity pool. For example,
1485 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
1486 &quot;A String&quot;,
1487 ],
1488 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
1489 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1490 #
1491 # For an overview of the IAM roles and permissions, see the
1492 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
1493 # a list of the available pre-defined roles, see
1494 # [here](https://cloud.google.com/iam/docs/understanding-roles).
1495 },
1496 ],
1497 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
1498 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
1499 &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
1500 # the policy is limited to a few 10s of KB. An empty policy is in general a
1501 # valid policy but certain services (like Projects) might reject them.
1502 # controls for Google Cloud resources.
1503 #
1504 #
1505 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
1506 # `members`, or principals, to a single `role`. Principals can be user
1507 # accounts, service accounts, Google groups, and domains (such as G Suite). A
1508 # `role` is a named list of permissions; each `role` can be an IAM predefined
1509 # role or a user-created custom role.
1510 #
1511 # For some types of Google Cloud resources, a `binding` can also specify a
1512 # `condition`, which is a logical expression that allows access to a resource
1513 # only if the expression evaluates to `true`. A condition can add constraints
1514 # based on attributes of the request, the resource, or both. To learn which
1515 # resources support conditions in their IAM policies, see the
1516 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1517 #
1518 # **JSON example:**
1519 #
1520 # ```
1521 # {
1522 # &quot;bindings&quot;: [
1523 # {
1524 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
1525 # &quot;members&quot;: [
1526 # &quot;user:[email protected]&quot;,
1527 # &quot;group:[email protected]&quot;,
1528 # &quot;domain:google.com&quot;,
1529 # &quot;serviceAccount:[email protected]&quot;
1530 # ]
1531 # },
1532 # {
1533 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
1534 # &quot;members&quot;: [
1535 # &quot;user:[email protected]&quot;
1536 # ],
1537 # &quot;condition&quot;: {
1538 # &quot;title&quot;: &quot;expirable access&quot;,
1539 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
1540 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
1541 # }
1542 # }
1543 # ],
1544 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
1545 # &quot;version&quot;: 3
1546 # }
1547 # ```
1548 #
1549 # **YAML example:**
1550 #
1551 # ```
1552 # bindings:
1553 # - members:
1554 # - user:[email protected]
1555 # - group:[email protected]
1556 # - domain:google.com
1557 # - serviceAccount:[email protected]
1558 # role: roles/resourcemanager.organizationAdmin
1559 # - members:
1560 # - user:[email protected]
1561 # role: roles/resourcemanager.organizationViewer
1562 # condition:
1563 # title: expirable access
1564 # description: Does not grant access after Sep 2020
1565 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
1566 # etag: BwWWja0YfJA=
1567 # version: 3
1568 # ```
1569 #
1570 # For a description of IAM and its features, see the
1571 # [IAM documentation](https://cloud.google.com/iam/docs/).
1572 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
1573 { # Specifies the audit configuration for a service.
1574 # The configuration determines which permission types are logged, and what
1575 # identities, if any, are exempted from logging.
1576 # An AuditConfig must have one or more AuditLogConfigs.
1577 #
1578 # If there are AuditConfigs for both `allServices` and a specific service,
1579 # the union of the two AuditConfigs is used for that service: the log_types
1580 # specified in each AuditConfig are enabled, and the exempted_members in each
1581 # AuditLogConfig are exempted.
1582 #
1583 # Example Policy with multiple AuditConfigs:
1584 #
1585 # {
1586 # &quot;audit_configs&quot;: [
1587 # {
1588 # &quot;service&quot;: &quot;allServices&quot;,
1589 # &quot;audit_log_configs&quot;: [
1590 # {
1591 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1592 # &quot;exempted_members&quot;: [
1593 # &quot;user:[email protected]&quot;
1594 # ]
1595 # },
1596 # {
1597 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1598 # },
1599 # {
1600 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
1601 # }
1602 # ]
1603 # },
1604 # {
1605 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
1606 # &quot;audit_log_configs&quot;: [
1607 # {
1608 # &quot;log_type&quot;: &quot;DATA_READ&quot;
1609 # },
1610 # {
1611 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
1612 # &quot;exempted_members&quot;: [
1613 # &quot;user:[email protected]&quot;
1614 # ]
1615 # }
1616 # ]
1617 # }
1618 # ]
1619 # }
1620 #
1621 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1622 # logging. It also exempts `[email protected]` from DATA_READ logging, and
1623 # `[email protected]` from DATA_WRITE logging.
1624 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
1625 { # Provides the configuration for logging a type of permissions.
1626 # Example:
1627 #
1628 # {
1629 # &quot;audit_log_configs&quot;: [
1630 # {
1631 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1632 # &quot;exempted_members&quot;: [
1633 # &quot;user:[email protected]&quot;
1634 # ]
1635 # },
1636 # {
1637 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1638 # }
1639 # ]
1640 # }
1641 #
1642 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
1643 # [email protected] from DATA_READ logging.
1644 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
1645 # permission.
1646 # Follows the same format of Binding.members.
1647 &quot;A String&quot;,
1648 ],
1649 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
1650 },
1651 ],
1652 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
1653 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
1654 # `allServices` is a special value that covers all services.
1655 },
1656 ],
1657 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
1658 # may specify a `condition` that determines how and when the `bindings` are
1659 # applied. Each of the `bindings` must contain at least one principal.
1660 #
1661 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
1662 # of these principals can be Google groups. Each occurrence of a principal
1663 # counts towards these limits. For example, if the `bindings` grant 50
1664 # different roles to `user:[email protected]`, and not to any other
1665 # principal, then you can add another 1,450 principals to the `bindings` in
1666 # the `Policy`.
1667 { # Associates `members`, or principals, with a `role`.
1668 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1669 #
1670 # If the condition evaluates to `true`, then this binding applies to the
1671 # current request.
1672 #
1673 # If the condition evaluates to `false`, then this binding does not apply to
1674 # the current request. However, a different role binding might grant the same
1675 # role to one or more of the principals in this binding.
1676 #
1677 # To learn which resources support conditions in their IAM policies, see the
1678 # [IAM
1679 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1680 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1681 # are documented at https://github.com/google/cel-spec.
1682 #
1683 # Example (Comparison):
1684 #
1685 # title: &quot;Summary size limit&quot;
1686 # description: &quot;Determines if a summary is less than 100 chars&quot;
1687 # expression: &quot;document.summary.size() &lt; 100&quot;
1688 #
1689 # Example (Equality):
1690 #
1691 # title: &quot;Requestor is owner&quot;
1692 # description: &quot;Determines if requestor is the document owner&quot;
1693 # expression: &quot;document.owner == request.auth.claims.email&quot;
1694 #
1695 # Example (Logic):
1696 #
1697 # title: &quot;Public documents&quot;
1698 # description: &quot;Determine whether the document should be publicly visible&quot;
1699 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
1700 #
1701 # Example (Data Manipulation):
1702 #
1703 # title: &quot;Notification string&quot;
1704 # description: &quot;Create a notification string with a timestamp.&quot;
1705 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
1706 #
1707 # The exact variables and functions that may be referenced within an expression
1708 # are determined by the service that evaluates it. See the service
1709 # documentation for additional information.
1710 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
1711 # describes the expression, e.g. when hovered over it in a UI.
1712 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
1713 # syntax.
1714 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
1715 # reporting, e.g. a file name and a position in the file.
1716 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
1717 # its purpose. This can be used e.g. in UIs which allow to enter the
1718 # expression.
1719 },
1720 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
1721 # `members` can have the following values:
1722 #
1723 # * `allUsers`: A special identifier that represents anyone who is
1724 # on the internet; with or without a Google account.
1725 #
1726 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1727 # who is authenticated with a Google account or a service account.
1728 # Does not include identities that come from external identity providers
1729 # (IdPs) through identity federation.
1730 #
1731 # * `user:{emailid}`: An email address that represents a specific Google
1732 # account. For example, `[email protected]` .
1733 #
1734 #
1735 # * `serviceAccount:{emailid}`: An email address that represents a Google
1736 # service account. For example,
1737 # `[email protected]`.
1738 #
1739 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
1740 # identifier for a
1741 # [Kubernetes service
1742 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
1743 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
1744 #
1745 # * `group:{emailid}`: An email address that represents a Google group.
1746 # For example, `[email protected]`.
1747 #
1748 #
1749 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1750 # users of that domain. For example, `google.com` or `example.com`.
1751 #
1752 #
1753 #
1754 #
1755 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1756 # A single identity in a workforce identity pool.
1757 #
1758 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
1759 # All workforce identities in a group.
1760 #
1761 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1762 # All workforce identities with a specific attribute value.
1763 #
1764 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
1765 # All identities in a workforce identity pool.
1766 #
1767 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
1768 # A single identity in a workload identity pool.
1769 #
1770 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
1771 # A workload identity pool group.
1772 #
1773 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1774 # All identities in a workload identity pool with a certain attribute.
1775 #
1776 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
1777 # All identities in a workload identity pool.
1778 #
1779 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1780 # identifier) representing a user that has been recently deleted. For
1781 # example, `[email protected]?uid=123456789012345678901`. If the user is
1782 # recovered, this value reverts to `user:{emailid}` and the recovered user
1783 # retains the role in the binding.
1784 #
1785 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1786 # unique identifier) representing a service account that has been recently
1787 # deleted. For example,
1788 # `[email protected]?uid=123456789012345678901`.
1789 # If the service account is undeleted, this value reverts to
1790 # `serviceAccount:{emailid}` and the undeleted service account retains the
1791 # role in the binding.
1792 #
1793 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1794 # identifier) representing a Google group that has been recently
1795 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
1796 # the group is recovered, this value reverts to `group:{emailid}` and the
1797 # recovered group retains the role in the binding.
1798 #
1799 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1800 # Deleted single identity in a workforce identity pool. For example,
1801 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
1802 &quot;A String&quot;,
1803 ],
1804 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
1805 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1806 #
1807 # For an overview of the IAM roles and permissions, see the
1808 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
1809 # a list of the available pre-defined roles, see
1810 # [here](https://cloud.google.com/iam/docs/understanding-roles).
1811 },
1812 ],
1813 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
1814 # prevent simultaneous updates of a policy from overwriting each other.
1815 # It is strongly suggested that systems make use of the `etag` in the
1816 # read-modify-write cycle to perform policy updates in order to avoid race
1817 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1818 # systems are expected to put that etag in the request to `setIamPolicy` to
1819 # ensure that their change will be applied to the same version of the policy.
1820 #
1821 # **Important:** If you use IAM Conditions, you must include the `etag` field
1822 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1823 # you to overwrite a version `3` policy with a version `1` policy, and all of
1824 # the conditions in the version `3` policy are lost.
1825 &quot;version&quot;: 42, # Specifies the format of the policy.
1826 #
1827 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
1828 # are rejected.
1829 #
1830 # Any operation that affects conditional role bindings must specify version
1831 # `3`. This requirement applies to the following operations:
1832 #
1833 # * Getting a policy that includes a conditional role binding
1834 # * Adding a conditional role binding to a policy
1835 # * Changing a conditional role binding in a policy
1836 # * Removing any role binding, with or without a condition, from a policy
1837 # that includes conditions
1838 #
1839 # **Important:** If you use IAM Conditions, you must include the `etag` field
1840 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1841 # you to overwrite a version `3` policy with a version `1` policy, and all of
1842 # the conditions in the version `3` policy are lost.
1843 #
1844 # If a policy does not include any conditions, operations on that policy may
1845 # specify any valid version or leave the field unset.
1846 #
1847 # To learn which resources support conditions in their IAM policies, see the
1848 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1849 },
1850 }
1851
1852 x__xgafv: string, V1 error format.
1853 Allowed values
1854 1 - v1 error format
1855 2 - v2 error format
1856
1857 Returns:
1858 An object of the form:
1859
1860 { # An Identity and Access Management (IAM) policy, which specifies access
1861 # controls for Google Cloud resources.
1862 #
1863 #
1864 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
1865 # `members`, or principals, to a single `role`. Principals can be user
1866 # accounts, service accounts, Google groups, and domains (such as G Suite). A
1867 # `role` is a named list of permissions; each `role` can be an IAM predefined
1868 # role or a user-created custom role.
1869 #
1870 # For some types of Google Cloud resources, a `binding` can also specify a
1871 # `condition`, which is a logical expression that allows access to a resource
1872 # only if the expression evaluates to `true`. A condition can add constraints
1873 # based on attributes of the request, the resource, or both. To learn which
1874 # resources support conditions in their IAM policies, see the
1875 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1876 #
1877 # **JSON example:**
1878 #
1879 # ```
1880 # {
1881 # &quot;bindings&quot;: [
1882 # {
1883 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
1884 # &quot;members&quot;: [
1885 # &quot;user:[email protected]&quot;,
1886 # &quot;group:[email protected]&quot;,
1887 # &quot;domain:google.com&quot;,
1888 # &quot;serviceAccount:[email protected]&quot;
1889 # ]
1890 # },
1891 # {
1892 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
1893 # &quot;members&quot;: [
1894 # &quot;user:[email protected]&quot;
1895 # ],
1896 # &quot;condition&quot;: {
1897 # &quot;title&quot;: &quot;expirable access&quot;,
1898 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
1899 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
1900 # }
1901 # }
1902 # ],
1903 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
1904 # &quot;version&quot;: 3
1905 # }
1906 # ```
1907 #
1908 # **YAML example:**
1909 #
1910 # ```
1911 # bindings:
1912 # - members:
1913 # - user:[email protected]
1914 # - group:[email protected]
1915 # - domain:google.com
1916 # - serviceAccount:[email protected]
1917 # role: roles/resourcemanager.organizationAdmin
1918 # - members:
1919 # - user:[email protected]
1920 # role: roles/resourcemanager.organizationViewer
1921 # condition:
1922 # title: expirable access
1923 # description: Does not grant access after Sep 2020
1924 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
1925 # etag: BwWWja0YfJA=
1926 # version: 3
1927 # ```
1928 #
1929 # For a description of IAM and its features, see the
1930 # [IAM documentation](https://cloud.google.com/iam/docs/).
1931 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
1932 { # Specifies the audit configuration for a service.
1933 # The configuration determines which permission types are logged, and what
1934 # identities, if any, are exempted from logging.
1935 # An AuditConfig must have one or more AuditLogConfigs.
1936 #
1937 # If there are AuditConfigs for both `allServices` and a specific service,
1938 # the union of the two AuditConfigs is used for that service: the log_types
1939 # specified in each AuditConfig are enabled, and the exempted_members in each
1940 # AuditLogConfig are exempted.
1941 #
1942 # Example Policy with multiple AuditConfigs:
1943 #
1944 # {
1945 # &quot;audit_configs&quot;: [
1946 # {
1947 # &quot;service&quot;: &quot;allServices&quot;,
1948 # &quot;audit_log_configs&quot;: [
1949 # {
1950 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1951 # &quot;exempted_members&quot;: [
1952 # &quot;user:[email protected]&quot;
1953 # ]
1954 # },
1955 # {
1956 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1957 # },
1958 # {
1959 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
1960 # }
1961 # ]
1962 # },
1963 # {
1964 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
1965 # &quot;audit_log_configs&quot;: [
1966 # {
1967 # &quot;log_type&quot;: &quot;DATA_READ&quot;
1968 # },
1969 # {
1970 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
1971 # &quot;exempted_members&quot;: [
1972 # &quot;user:[email protected]&quot;
1973 # ]
1974 # }
1975 # ]
1976 # }
1977 # ]
1978 # }
1979 #
1980 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1981 # logging. It also exempts `[email protected]` from DATA_READ logging, and
1982 # `[email protected]` from DATA_WRITE logging.
1983 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
1984 { # Provides the configuration for logging a type of permissions.
1985 # Example:
1986 #
1987 # {
1988 # &quot;audit_log_configs&quot;: [
1989 # {
1990 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1991 # &quot;exempted_members&quot;: [
1992 # &quot;user:[email protected]&quot;
1993 # ]
1994 # },
1995 # {
1996 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1997 # }
1998 # ]
1999 # }
2000 #
2001 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
2002 # [email protected] from DATA_READ logging.
2003 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
2004 # permission.
2005 # Follows the same format of Binding.members.
2006 &quot;A String&quot;,
2007 ],
2008 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
2009 },
2010 ],
2011 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
2012 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
2013 # `allServices` is a special value that covers all services.
2014 },
2015 ],
2016 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
2017 # may specify a `condition` that determines how and when the `bindings` are
2018 # applied. Each of the `bindings` must contain at least one principal.
2019 #
2020 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
2021 # of these principals can be Google groups. Each occurrence of a principal
2022 # counts towards these limits. For example, if the `bindings` grant 50
2023 # different roles to `user:[email protected]`, and not to any other
2024 # principal, then you can add another 1,450 principals to the `bindings` in
2025 # the `Policy`.
2026 { # Associates `members`, or principals, with a `role`.
2027 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
2028 #
2029 # If the condition evaluates to `true`, then this binding applies to the
2030 # current request.
2031 #
2032 # If the condition evaluates to `false`, then this binding does not apply to
2033 # the current request. However, a different role binding might grant the same
2034 # role to one or more of the principals in this binding.
2035 #
2036 # To learn which resources support conditions in their IAM policies, see the
2037 # [IAM
2038 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2039 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
2040 # are documented at https://github.com/google/cel-spec.
2041 #
2042 # Example (Comparison):
2043 #
2044 # title: &quot;Summary size limit&quot;
2045 # description: &quot;Determines if a summary is less than 100 chars&quot;
2046 # expression: &quot;document.summary.size() &lt; 100&quot;
2047 #
2048 # Example (Equality):
2049 #
2050 # title: &quot;Requestor is owner&quot;
2051 # description: &quot;Determines if requestor is the document owner&quot;
2052 # expression: &quot;document.owner == request.auth.claims.email&quot;
2053 #
2054 # Example (Logic):
2055 #
2056 # title: &quot;Public documents&quot;
2057 # description: &quot;Determine whether the document should be publicly visible&quot;
2058 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
2059 #
2060 # Example (Data Manipulation):
2061 #
2062 # title: &quot;Notification string&quot;
2063 # description: &quot;Create a notification string with a timestamp.&quot;
2064 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
2065 #
2066 # The exact variables and functions that may be referenced within an expression
2067 # are determined by the service that evaluates it. See the service
2068 # documentation for additional information.
2069 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
2070 # describes the expression, e.g. when hovered over it in a UI.
2071 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
2072 # syntax.
2073 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
2074 # reporting, e.g. a file name and a position in the file.
2075 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
2076 # its purpose. This can be used e.g. in UIs which allow to enter the
2077 # expression.
2078 },
2079 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
2080 # `members` can have the following values:
2081 #
2082 # * `allUsers`: A special identifier that represents anyone who is
2083 # on the internet; with or without a Google account.
2084 #
2085 # * `allAuthenticatedUsers`: A special identifier that represents anyone
2086 # who is authenticated with a Google account or a service account.
2087 # Does not include identities that come from external identity providers
2088 # (IdPs) through identity federation.
2089 #
2090 # * `user:{emailid}`: An email address that represents a specific Google
2091 # account. For example, `[email protected]` .
2092 #
2093 #
2094 # * `serviceAccount:{emailid}`: An email address that represents a Google
2095 # service account. For example,
2096 # `[email protected]`.
2097 #
2098 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
2099 # identifier for a
2100 # [Kubernetes service
2101 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
2102 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
2103 #
2104 # * `group:{emailid}`: An email address that represents a Google group.
2105 # For example, `[email protected]`.
2106 #
2107 #
2108 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
2109 # users of that domain. For example, `google.com` or `example.com`.
2110 #
2111 #
2112 #
2113 #
2114 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2115 # A single identity in a workforce identity pool.
2116 #
2117 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
2118 # All workforce identities in a group.
2119 #
2120 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2121 # All workforce identities with a specific attribute value.
2122 #
2123 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
2124 # All identities in a workforce identity pool.
2125 #
2126 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
2127 # A single identity in a workload identity pool.
2128 #
2129 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
2130 # A workload identity pool group.
2131 #
2132 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2133 # All identities in a workload identity pool with a certain attribute.
2134 #
2135 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
2136 # All identities in a workload identity pool.
2137 #
2138 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
2139 # identifier) representing a user that has been recently deleted. For
2140 # example, `[email protected]?uid=123456789012345678901`. If the user is
2141 # recovered, this value reverts to `user:{emailid}` and the recovered user
2142 # retains the role in the binding.
2143 #
2144 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
2145 # unique identifier) representing a service account that has been recently
2146 # deleted. For example,
2147 # `[email protected]?uid=123456789012345678901`.
2148 # If the service account is undeleted, this value reverts to
2149 # `serviceAccount:{emailid}` and the undeleted service account retains the
2150 # role in the binding.
2151 #
2152 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
2153 # identifier) representing a Google group that has been recently
2154 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
2155 # the group is recovered, this value reverts to `group:{emailid}` and the
2156 # recovered group retains the role in the binding.
2157 #
2158 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2159 # Deleted single identity in a workforce identity pool. For example,
2160 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
2161 &quot;A String&quot;,
2162 ],
2163 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
2164 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
2165 #
2166 # For an overview of the IAM roles and permissions, see the
2167 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
2168 # a list of the available pre-defined roles, see
2169 # [here](https://cloud.google.com/iam/docs/understanding-roles).
2170 },
2171 ],
2172 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
2173 # prevent simultaneous updates of a policy from overwriting each other.
2174 # It is strongly suggested that systems make use of the `etag` in the
2175 # read-modify-write cycle to perform policy updates in order to avoid race
2176 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
2177 # systems are expected to put that etag in the request to `setIamPolicy` to
2178 # ensure that their change will be applied to the same version of the policy.
2179 #
2180 # **Important:** If you use IAM Conditions, you must include the `etag` field
2181 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
2182 # you to overwrite a version `3` policy with a version `1` policy, and all of
2183 # the conditions in the version `3` policy are lost.
2184 &quot;version&quot;: 42, # Specifies the format of the policy.
2185 #
2186 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
2187 # are rejected.
2188 #
2189 # Any operation that affects conditional role bindings must specify version
2190 # `3`. This requirement applies to the following operations:
2191 #
2192 # * Getting a policy that includes a conditional role binding
2193 # * Adding a conditional role binding to a policy
2194 # * Changing a conditional role binding in a policy
2195 # * Removing any role binding, with or without a condition, from a policy
2196 # that includes conditions
2197 #
2198 # **Important:** If you use IAM Conditions, you must include the `etag` field
2199 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
2200 # you to overwrite a version `3` policy with a version `1` policy, and all of
2201 # the conditions in the version `3` policy are lost.
2202 #
2203 # If a policy does not include any conditions, operations on that policy may
2204 # specify any valid version or leave the field unset.
2205 #
2206 # To learn which resources support conditions in their IAM policies, see the
2207 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2208 }</pre>
2209 </div>
2210
2211 <div class="method">
2212 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code>
2213 <pre>Returns permissions that a caller has on the specified resource.
2214
2215 Args:
2216 project: string, Project ID for this request. (required)
2217 resource: string, Name or id of the resource for this request. (required)
2218 body: object, The request body.
2219 The object takes the form of:
2220
2221 {
2222 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
2223 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
2224 &quot;A String&quot;,
2225 ],
2226 }
2227
2228 x__xgafv: string, V1 error format.
2229 Allowed values
2230 1 - v1 error format
2231 2 - v2 error format
2232
2233 Returns:
2234 An object of the form:
2235
2236 {
2237 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
2238 # allowed.
2239 &quot;A String&quot;,
2240 ],
2241 }</pre>
2242 </div>
2243
2244 </body></html>