Debian Codegraph @

docs/dyn/compute_beta.interconnectAttachmentGroups.html

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