Debian Codegraph @

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