Debian Codegraph @

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