Debian Codegraph @

docs/dyn/compute_alpha.interconnectAttachmentGroups.html

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