Debian Codegraph @

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