Debian Codegraph @

docs/dyn/compute_alpha.instantSnapshotGroups.html

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