Debian Codegraph @

docs/dyn/compute_alpha.interconnectAttachments.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.interconnectAttachments.html">interconnectAttachments</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Retrieves an aggregated list of interconnect attachments.</p>
80 <p class="toc_element">
81 <code><a href="#aggregatedList_next">aggregatedList_next()</a></code></p>
82 <p class="firstline">Retrieves the next page of results.</p>
83 <p class="toc_element">
84 <code><a href="#close">close()</a></code></p>
85 <p class="firstline">Close httplib2 connections.</p>
86 <p class="toc_element">
87 <code><a href="#delete">delete(project, region, interconnectAttachment, requestId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Deletes the specified interconnect attachment.</p>
89 <p class="toc_element">
90 <code><a href="#get">get(project, region, interconnectAttachment, x__xgafv=None)</a></code></p>
91 <p class="firstline">Returns the specified interconnect attachment.</p>
92 <p class="toc_element">
93 <code><a href="#getIamPolicy">getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Gets the access control policy for a resource. May be empty if no such</p>
95 <p class="toc_element">
96 <code><a href="#insert">insert(project, region, body=None, requestId=None, validateOnly=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Creates an InterconnectAttachment in the specified project using the data</p>
98 <p class="toc_element">
99 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Retrieves the list of interconnect attachments contained within</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, region, interconnectAttachment, body=None, requestId=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Updates the specified interconnect attachment with the data included in the</p>
107 <p class="toc_element">
108 <code><a href="#setIamPolicy">setIamPolicy(project, region, 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="#setLabels">setLabels(project, region, resource, body=None, requestId=None, x__xgafv=None)</a></code></p>
112 <p class="firstline">Sets the labels on an InterconnectAttachment. To learn more about labels,</p>
113 <p class="toc_element">
114 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</a></code></p>
115 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
116 <h3>Method Details</h3>
117 <div class="method">
118 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</code>
119 <pre>Retrieves an aggregated list of interconnect attachments.
120
121 To prevent failure, Google recommends that you set the
122 `returnPartialSuccess` parameter to `true`.
123
124 Args:
125 project: string, Project ID for this request. (required)
126 filter: string, A filter expression that filters resources listed in the response. Most
127 Compute resources support two types of filter expressions:
128 expressions that support regular expressions and expressions that follow
129 API improvement proposal AIP-160.
130 These two types of filter expressions cannot be mixed in one request.
131
132 If you want to use AIP-160, your expression must specify the field name, an
133 operator, and the value that you want to use for filtering. The value
134 must be a string, a number, or a boolean. The operator
135 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
136
137 For example, if you are filtering Compute Engine instances, you can
138 exclude instances named `example-instance` by specifying
139 `name != example-instance`.
140
141 The `:*` comparison can be used to test whether a key has been defined.
142 For example, to find all objects with `owner` label use:
143 ```
144 labels.owner:*
145 ```
146
147 You can also filter nested fields. For example, you could specify
148 `scheduling.automaticRestart = false` to include instances only
149 if they are not scheduled for automatic restarts. You can use filtering
150 on nested fields to filter based onresource labels.
151
152 To filter on multiple expressions, provide each separate expression within
153 parentheses. For example:
154 ```
155 (scheduling.automaticRestart = true)
156 (cpuPlatform = &quot;Intel Skylake&quot;)
157 ```
158 By default, each expression is an `AND` expression. However, you
159 can include `AND` and `OR` expressions explicitly.
160 For example:
161 ```
162 (cpuPlatform = &quot;Intel Skylake&quot;) OR
163 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
164 (scheduling.automaticRestart = true)
165 ```
166
167 If you want to use a regular expression, use the `eq` (equal) or `ne`
168 (not equal) operator against a single un-parenthesized expression with or
169 without quotes or against multiple parenthesized expressions. Examples:
170
171 `fieldname eq unquoted literal`
172 `fieldname eq &#x27;single quoted literal&#x27;`
173 `fieldname eq &quot;double quoted literal&quot;`
174 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
175
176 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
177 The literal value must match the entire field.
178
179 For example, to filter for instances that do not end with name &quot;instance&quot;,
180 you would use `name ne .*instance`.
181
182 You cannot combine constraints on multiple fields using regular
183 expressions.
184 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
185 global) should be included in the response. For new resource types added
186 after this field, the flag has no effect as new resource types will always
187 include every visible scope for each scope type in response. For resource
188 types which predate this field, if this flag is omitted or false, only
189 scopes of the scope types where the resource type is expected to be found
190 will be included.
191 maxResults: integer, The maximum number of results per page that should be returned.
192 If the number of available results is larger than `maxResults`,
193 Compute Engine returns a `nextPageToken` that can be used to get
194 the next page of results in subsequent list requests. Acceptable values are
195 `0` to `500`, inclusive. (Default: `500`)
196 orderBy: string, Sorts list results by a certain order. By default, results
197 are returned in alphanumerical order based on the resource name.
198
199 You can also sort results in descending order based on the creation
200 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
201 results based on the `creationTimestamp` field in
202 reverse chronological order (newest result first). Use this to sort
203 resources like operations so that the newest operation is returned first.
204
205 Currently, only sorting by `name` or
206 `creationTimestamp desc` is supported.
207 pageToken: string, Specifies a page token to use. Set `pageToken` to the
208 `nextPageToken` returned by a previous list request to get
209 the next page of results.
210 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
211 of failure. The default value is false.
212
213 For example, when partial success behavior is enabled, aggregatedList for a
214 single zone scope either returns all resources in the zone or no resources,
215 with an error code.
216 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
217 aggregated list request is invoked for subnetworks list-usable api.
218 x__xgafv: string, V1 error format.
219 Allowed values
220 1 - v1 error format
221 2 - v2 error format
222
223 Returns:
224 An object of the form:
225
226 {
227 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
228 &quot;items&quot;: { # A list of InterconnectAttachmentsScopedList resources.
229 &quot;a_key&quot;: { # Name of the scope containing this set of interconnect attachments.
230 &quot;interconnectAttachments&quot;: [ # A list of interconnect attachments contained in this scope.
231 { # Represents an Interconnect Attachment (VLAN) resource.
232 #
233 # You can use Interconnect attachments (VLANS) to connect your Virtual Private
234 # Cloud networks to your on-premises networks through an Interconnect.
235 # For more information, read
236 # Creating VLAN Attachments.
237 &quot;adminEnabled&quot;: True or False, # Determines whether this Attachment will carry packets.
238 # Not present for PARTNER_PROVIDER.
239 &quot;attachmentGroup&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the AttachmentGroup that includes this Attachment.
240 &quot;bandwidth&quot;: &quot;A String&quot;, # Provisioned bandwidth capacity for the interconnect attachment. For
241 # attachments of type DEDICATED, the user can set the bandwidth.
242 # For attachments of type PARTNER, the Google Partner that is operating
243 # the interconnect must set the bandwidth.
244 # Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED,
245 # and can take one of the following values:
246 #
247 # - BPS_50M: 50 Mbit/s
248 # - BPS_100M: 100 Mbit/s
249 # - BPS_200M: 200 Mbit/s
250 # - BPS_300M: 300 Mbit/s
251 # - BPS_400M: 400 Mbit/s
252 # - BPS_500M: 500 Mbit/s
253 # - BPS_1G: 1 Gbit/s
254 # - BPS_2G: 2 Gbit/s
255 # - BPS_5G: 5 Gbit/s
256 # - BPS_10G: 10 Gbit/s
257 # - BPS_20G: 20 Gbit/s
258 # - BPS_50G: 50 Gbit/s
259 # - BPS_100G: 100 Gbit/s
260 # - BPS_400G: 400 Gbit/s
261 &quot;candidateCloudRouterIpAddress&quot;: &quot;A String&quot;, # Single IPv4 address + prefix length to be configured on the cloud router
262 # interface for this interconnect attachment.
263 #
264 # - Both candidate_cloud_router_ip_address and
265 # candidate_customer_router_ip_address fields must be set or both must be
266 # unset.
267 # - Prefix length of both candidate_cloud_router_ip_address and
268 # candidate_customer_router_ip_address must be the same.
269 # - Max prefix length is 31.
270 &quot;candidateCloudRouterIpv6Address&quot;: &quot;A String&quot;, # Single IPv6 address + prefix length to be configured on the cloud router
271 # interface for this interconnect attachment.
272 #
273 # - Both candidate_cloud_router_ipv6_address and
274 # candidate_customer_router_ipv6_address fields must be set or both must be
275 # unset.
276 # - Prefix length of both candidate_cloud_router_ipv6_address and
277 # candidate_customer_router_ipv6_address must be the same.
278 # - Max prefix length is 126.
279 &quot;candidateCustomerRouterIpAddress&quot;: &quot;A String&quot;, # Single IPv4 address + prefix length to be configured on the customer router
280 # interface for this interconnect attachment.
281 &quot;candidateCustomerRouterIpv6Address&quot;: &quot;A String&quot;, # Single IPv6 address + prefix length to be configured on the customer router
282 # interface for this interconnect attachment.
283 &quot;candidateIpv6Subnets&quot;: [ # This field is not available.
284 &quot;A String&quot;,
285 ],
286 &quot;candidateSubnets&quot;: [ # Input only. Up to 16 candidate prefixes that can be used to restrict the allocation
287 # of cloudRouterIpAddress and customerRouterIpAddress for this attachment.
288 # All prefixes must be within link-local address space (169.254.0.0/16) and
289 # must be /29 or shorter (/28, /27, etc). Google will attempt to select an
290 # unused /29 from the supplied candidate prefix(es). The request will fail if
291 # all possible /29s are in use on Google&#x27;s edge. If not supplied, Google will
292 # randomly select an unused /29 from all of link-local space.
293 &quot;A String&quot;,
294 ],
295 &quot;cloudRouterIpAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IPv4 address + prefix length to be configured on Cloud Router
296 # Interface for this interconnect attachment.
297 &quot;cloudRouterIpv6Address&quot;: &quot;A String&quot;, # Output only. [Output Only] IPv6 address + prefix length to be configured on Cloud
298 # Router Interface for this interconnect attachment.
299 &quot;cloudRouterIpv6InterfaceId&quot;: &quot;A String&quot;, # This field is not available.
300 &quot;configurationConstraints&quot;: { # Output only. [Output Only] Constraints for this attachment, if any. The attachment does
301 # not work if these constraints are not met.
302 &quot;bgpMd5&quot;: &quot;A String&quot;, # Output only. [Output Only] Whether the attachment&#x27;s BGP session
303 # requires/allows/disallows BGP MD5 authentication. This can take one of
304 # the following values: MD5_OPTIONAL, MD5_REQUIRED, MD5_UNSUPPORTED.
305 #
306 # For example, a Cross-Cloud Interconnect connection to a remote cloud
307 # provider that requires BGP MD5 authentication has the
308 # interconnectRemoteLocation attachment_configuration_constraints.bgp_md5
309 # field set to MD5_REQUIRED, and that property is propagated to the
310 # attachment. Similarly, if BGP MD5 is MD5_UNSUPPORTED, an error is
311 # returned if MD5 is requested.
312 &quot;bgpPeerAsnRanges&quot;: [ # Output only. [Output Only] List of ASN ranges that the remote location is known to
313 # support. Formatted as an array of inclusive ranges {min: min-value, max:
314 # max-value}. For example, [{min: 123, max: 123}, {min: 64512, max: 65534}]
315 # allows the peer ASN to be 123 or anything in the range 64512-65534.
316 #
317 # This field is only advisory. Although the API accepts other ranges, these
318 # are the ranges that we recommend.
319 {
320 &quot;max&quot;: 42,
321 &quot;min&quot;: 42,
322 },
323 ],
324 },
325 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
326 # text format.
327 &quot;customerRouterIpAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IPv4 address + prefix length to be configured on the customer
328 # router subinterface for this interconnect attachment.
329 &quot;customerRouterIpv6Address&quot;: &quot;A String&quot;, # Output only. [Output Only] IPv6 address + prefix length to be configured on the
330 # customer router subinterface for this interconnect attachment.
331 &quot;customerRouterIpv6InterfaceId&quot;: &quot;A String&quot;, # This field is not available.
332 &quot;dataplaneVersion&quot;: 42, # Output only. [Output Only] Dataplane version for this InterconnectAttachment. This
333 # field is only present for Dataplane version 2 and higher. Absence of this
334 # field in the API output indicates that the Dataplane is version 1.
335 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource.
336 &quot;edgeAvailabilityDomain&quot;: &quot;A String&quot;, # Input only. Desired availability domain for the attachment. Only available for type
337 # PARTNER, at creation time, and can take one of the following values:
338 #
339 # - AVAILABILITY_DOMAIN_ANY
340 # - AVAILABILITY_DOMAIN_1
341 # - AVAILABILITY_DOMAIN_2
342 #
343 #
344 # For improved reliability, customers should configure a pair of attachments,
345 # one per availability domain. The selected availability domain will be
346 # provided to the Partner via the pairing key, so that the provisioned
347 # circuit will lie in the specified domain. If not specified, the value will
348 # default to AVAILABILITY_DOMAIN_ANY.
349 &quot;encryption&quot;: &quot;A String&quot;, # Indicates the user-supplied encryption option of this VLAN attachment
350 # (interconnectAttachment). Can only be specified at attachment creation
351 # for PARTNER or DEDICATED attachments.
352 # Possible values are:
353 #
354 # - NONE - This is the default value, which means that the
355 # VLAN attachment carries unencrypted traffic. VMs are able to send
356 # traffic to, or receive traffic from, such a VLAN attachment.
357 # - IPSEC - The VLAN attachment carries only encrypted
358 # traffic that is encrypted by an IPsec device, such as an HA VPN gateway or
359 # third-party IPsec VPN. VMs cannot directly send traffic to, or receive
360 # traffic from, such a VLAN attachment. To use *HA VPN over Cloud
361 # Interconnect*, the VLAN attachment must be created with this
362 # option.
363 &quot;googleReferenceId&quot;: &quot;A String&quot;, # Output only. [Output Only] Google reference ID, to be used when raising support tickets
364 # with Google or otherwise to debug backend connectivity issues.
365 # [Deprecated] This field is not used.
366 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
367 # defined by the server.
368 &quot;interconnect&quot;: &quot;A String&quot;, # URL of the underlying Interconnect object that this attachment&#x27;s traffic
369 # will traverse through.
370 &quot;ipsecInternalAddresses&quot;: [ # A list of URLs of addresses that have been reserved for the VLAN
371 # attachment. Used only for the VLAN attachment that has the encryption
372 # option as IPSEC. The addresses must be regional internal IP address ranges.
373 # When creating an HA VPN gateway over the VLAN attachment, if the attachment
374 # is configured to use a regional internal IP address, then the VPN gateway&#x27;s
375 # IP address is allocated from the IP address range specified here. For
376 # example, if the HA VPN gateway&#x27;s interface 0 is paired to this VLAN
377 # attachment, then a regional internal IP address for the VPN gateway
378 # interface 0 will be allocated from the IP address specified for this
379 # VLAN attachment.
380 # If this field is not specified when creating the VLAN attachment, then
381 # later on when creating an HA VPN gateway on this VLAN attachment, the HA
382 # VPN gateway&#x27;s IP address is allocated from the regional external IP address
383 # pool.
384 &quot;A String&quot;,
385 ],
386 &quot;kind&quot;: &quot;compute#interconnectAttachment&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#interconnectAttachment for interconnect attachments.
387 &quot;l2Forwarding&quot;: { # L2 Interconnect Attachment related configuration. # L2 Interconnect Attachment related config. This field is required if the
388 # type is L2_DEDICATED.
389 #
390 # The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad)
391 # within L2 packets are mapped to the destination appliances IP addresses.
392 # The packet is then encapsulated with the appliance IP address and sent to
393 # the edge appliance.
394 &quot;applianceMappings&quot;: { # Optional. A map of VLAN tags to appliances and optional inner mapping
395 # rules. If VLANs are not explicitly mapped to any appliance, the
396 # defaultApplianceIpAddress is used.
397 #
398 # Each VLAN tag can be a single number or a range of numbers in the range
399 # of 1 to 4094, e.g., &quot;1&quot; or &quot;4001-4094&quot;. Non-empty and non-overlapping
400 # VLAN tag ranges are enforced, and violating operations will be rejected.
401 #
402 # The VLAN tags in the Ethernet header must use an ethertype value of
403 # 0x88A8 or 0x8100.
404 &quot;a_key&quot;: { # Two-level VLAN-to-Appliance mapping rule.
405 &quot;applianceIpAddress&quot;: &quot;A String&quot;, # Optional. A single IPv4 or IPv6 address used as the destination IP
406 # address for ingress packets that match on a VLAN tag, but do not match
407 # a more specific inner VLAN tag.
408 #
409 # Unset field (null-value) indicates both VLAN tags are required to be
410 # mapped. Otherwise, defaultApplianceIpAddress is used.
411 &quot;innerVlanToApplianceMappings&quot;: [ # Optional. Used to match against the inner VLAN when the packet
412 # contains two VLAN tags.
413 #
414 # A list of mapping rules from inner VLAN tags to IP addresses. If the
415 # inner VLAN is not explicitly mapped to an IP address range, the
416 # applianceIpAddress is used.
417 { # The inner VLAN-to-Appliance mapping.
418 &quot;innerApplianceIpAddress&quot;: &quot;A String&quot;, # Required in this object. A single IPv4 or IPv6 address used as the
419 # destination IP address for ingress packets that match on both VLAN
420 # tags.
421 &quot;innerVlanTags&quot;: [ # Required in this object. Used to match the inner VLAN tag on the
422 # packet. Each entry can be a single number or a range of numbers in
423 # the range of 1 to 4094, e.g., [&quot;1&quot;, &quot;4001-4094&quot;] is valid. Non-empty
424 # and Non-overlapping VLAN tag ranges are enforced, and violating
425 # operations will be rejected.
426 #
427 # The inner VLAN tags must have an ethertype value of 0x8100.
428 &quot;A String&quot;,
429 ],
430 },
431 ],
432 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of this appliance mapping rule.
433 },
434 },
435 &quot;defaultApplianceIpAddress&quot;: &quot;A String&quot;, # Optional. A single IPv4 or IPv6 address used as the default destination
436 # IP when there is no VLAN mapping result found.
437 #
438 # Unset field (null-value) indicates the unmatched packet should be
439 # dropped.
440 &quot;geneveHeader&quot;: { # GeneveHeader related configurations. # Optional. It represents the structure of a Geneve (Generic Network
441 # Virtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various
442 # protocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization
443 # environments.
444 &quot;vni&quot;: 42, # Optional. VNI is a 24-bit unique virtual network identifier, from 0 to
445 # 16,777,215.
446 },
447 &quot;network&quot;: &quot;A String&quot;, # Required. Resource URL of the network to which this attachment belongs.
448 &quot;tunnelEndpointIpAddress&quot;: &quot;A String&quot;, # Required. A single IPv4 or IPv6 address. This address will be used as the
449 # source IP address for packets sent to the appliances, and must be used as
450 # the destination IP address for packets that should be sent out through
451 # this attachment.
452 },
453 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this InterconnectAttachment,
454 # which is essentially a hash of the labels set used for optimistic locking.
455 # The fingerprint is initially generated by Compute Engine and changes after
456 # every request to modify or update labels. You must always provide an
457 # up-to-date fingerprint hash in order to update or change labels,
458 # otherwise the request will fail with error412 conditionNotMet.
459 #
460 # To see the latest fingerprint, make a get() request to
461 # retrieve an InterconnectAttachment.
462 &quot;labels&quot;: { # Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
463 # Label values may be empty.
464 &quot;a_key&quot;: &quot;A String&quot;,
465 },
466 &quot;mtu&quot;: 42, # Maximum Transmission Unit (MTU), in bytes, of packets passing through this
467 # interconnect attachment.
468 # Valid values are 1440, 1460, 1500, and 8896. If not specified,
469 # the value will default to 1440.
470 &quot;multicastEnabled&quot;: True or False, # Whether or not to permit multicast traffic for this attachment. Multicast
471 # packets will be dropped if this is not enabled.
472 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
473 # The name must be 1-63 characters long, and comply withRFC1035.
474 # Specifically, the name must be 1-63 characters long and match the regular
475 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
476 # character must be a lowercase letter, and all following characters must
477 # be a dash, lowercase letter, or digit, except the last character, which
478 # cannot be a dash.
479 &quot;operationalStatus&quot;: &quot;A String&quot;, # Output only. [Output Only] The current status of whether or not this interconnect
480 # attachment is functional, which can take one of the following values:
481 #
482 # - OS_ACTIVE: The attachment has been turned up and is ready to
483 # use.
484 # - OS_UNPROVISIONED: The attachment is not ready to use yet,
485 # because turnup is not complete.
486 &quot;pairingKey&quot;: &quot;A String&quot;, # [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not
487 # present for DEDICATED].
488 # The opaque identifier of a PARTNER attachment used to initiate
489 # provisioning with a selected partner.
490 # Of the form &quot;XXXXX/region/domain&quot;
491 &quot;params&quot;: { # Additional interconnect attachment parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
492 # as part of resource payload.
493 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
494 # Tag keys and values have the same definition as resource
495 # manager tags. The field is allowed for INSERT
496 # only. The keys/values to set on the resource should be specified in
497 # either ID { : } or Namespaced format
498 # { : }.
499 # For example the following are valid inputs:
500 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
501 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
502 # Note:
503 # * Invalid combinations of ID &amp; namespaced format is not supported. For
504 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
505 # * Inconsistent format is not supported. For instance:
506 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
507 &quot;a_key&quot;: &quot;A String&quot;,
508 },
509 },
510 &quot;partnerAsn&quot;: &quot;A String&quot;, # Optional BGP ASN for the router supplied by a Layer 3 Partner if they
511 # configured BGP on behalf of the customer.
512 # Output only for PARTNER type, input only for PARTNER_PROVIDER, not
513 # available for DEDICATED.
514 &quot;partnerMetadata&quot;: { # Informational metadata about Partner attachments from Partners to display # Informational metadata about Partner attachments from Partners to display
515 # to customers.
516 # Output only for PARTNER type, mutable for PARTNER_PROVIDER, not
517 # available for DEDICATED.
518 # to customers. These fields are propagated from PARTNER_PROVIDER
519 # attachments to their corresponding PARTNER attachments.
520 &quot;interconnectName&quot;: &quot;A String&quot;, # Plain text name of the Interconnect this attachment is connected to, as
521 # displayed in the Partner&#x27;s portal. For instance &quot;Chicago 1&quot;.
522 # This value may be validated to match approved Partner values.
523 &quot;partnerName&quot;: &quot;A String&quot;, # Plain text name of the Partner providing this attachment.
524 # This value may be validated to match approved Partner values.
525 &quot;portalUrl&quot;: &quot;A String&quot;, # URL of the Partner&#x27;s portal for this Attachment. Partners may customise
526 # this to be a deep link to the specific resource on the Partner portal.
527 # This value may be validated to match approved Partner values.
528 },
529 &quot;privateInterconnectInfo&quot;: { # Information for an interconnect attachment when this belongs to an # Output only. [Output Only] Information specific to an InterconnectAttachment.
530 # This property is populated if the interconnect that
531 # this is attached to is of type DEDICATED.
532 # interconnect of type DEDICATED.
533 &quot;tag8021q&quot;: 42, # [Output Only] 802.1q encapsulation tag to be used for traffic between
534 # Google and the customer, going to and from this network and region.
535 },
536 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional interconnect attachment
537 # resides.
538 # You must specify this field as part of the HTTP request URL. It is
539 # not settable as a field in the request body.
540 &quot;remoteService&quot;: &quot;A String&quot;, # Output only. [Output Only]
541 # If the attachment is on a Cross-Cloud Interconnect connection, this field
542 # contains the interconnect&#x27;s remote location service provider. Example
543 # values: &quot;Amazon Web Services&quot; &quot;Microsoft Azure&quot;.
544 #
545 # The field is set only for attachments on Cross-Cloud Interconnect
546 # connections. Its value is copied from the InterconnectRemoteLocation
547 # remoteService field.
548 &quot;router&quot;: &quot;A String&quot;, # URL of the Cloud Router to be used for dynamic routing. This router must be
549 # in the same region as this InterconnectAttachment. The
550 # InterconnectAttachment will automatically connect the Interconnect to the
551 # network &amp; region within which the Cloud Router is configured.
552 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
553 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
554 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
555 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this interconnect attachment to identify whether the
556 # IPv6 feature is enabled or not. If not specified, IPV4_ONLY
557 # will be used.
558 #
559 # This field can be both set at interconnect attachments creation and
560 # update interconnect attachment operations.
561 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The current state of this attachment&#x27;s functionality.
562 # Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE,
563 # PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values
564 # PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used
565 # for only PARTNER and PARTNER_PROVIDER interconnect attachments.
566 # This state can take one of the following values:
567 #
568 # - ACTIVE: The attachment has been turned up and is ready to use.
569 # - UNPROVISIONED: The attachment is not ready to use yet, because turnup
570 # is not complete.
571 # - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet
572 # been configured on the Partner side.
573 # - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of
574 # provisioning after a PARTNER_PROVIDER attachment was created that
575 # references it.
576 # - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER
577 # attachment that is waiting for a customer to activate it.
578 # - DEFUNCT:
579 # The attachment was deleted externally and is no longer functional. This
580 # could be because the associated Interconnect was removed, or because the
581 # other side of a Partner attachment was deleted.
582 &quot;subnetLength&quot;: 42, # Input only. Length of the IPv4 subnet mask.
583 # Allowed values:
584 #
585 #
586 # - 29 (default)
587 # - 30
588 #
589 # The default value is 29, except for Cross-Cloud Interconnect
590 # connections that use an InterconnectRemoteLocation with a
591 # constraints.subnetLengthRange.min equal to 30. For example,
592 # connections that use an Azure remote location fall into this
593 # category. In these cases, the default value is 30, and requesting
594 # 29 returns an error.
595 #
596 # Where both 29 and 30 are allowed, 29 is preferred, because it gives
597 # Google Cloud Support more debugging visibility.
598 &quot;type&quot;: &quot;A String&quot;, # The type of interconnect attachment this is, which can take one of the
599 # following values:
600 #
601 # - DEDICATED: an attachment to a Dedicated Interconnect.
602 # - PARTNER: an attachment to a Partner Interconnect, created by the
603 # customer.
604 # - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by
605 # the partner.
606 #
607 # - L2_DEDICATED: a L2 attachment to a Dedicated Interconnect.
608 &quot;vlanTag8021q&quot;: 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093.
609 # Only specified at creation time.
610 },
611 ],
612 &quot;warning&quot;: { # Informational warning which replaces the list of addresses when
613 # the list is empty.
614 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
615 # Engine returns NO_RESULTS_ON_PAGE if there
616 # are no results in the response.
617 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
618 # value format. For example:
619 #
620 # &quot;data&quot;: [
621 # {
622 # &quot;key&quot;: &quot;scope&quot;,
623 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
624 # }
625 {
626 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
627 # returned. For example, for warnings where there are no results in a list
628 # request for a particular zone, this key might be scope and
629 # the key value might be the zone name. Other examples might be a key
630 # indicating a deprecated resource and a suggested replacement, or a
631 # warning about invalid network settings (for example, if an instance
632 # attempts to perform IP forwarding but is not enabled for IP forwarding).
633 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
634 },
635 ],
636 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
637 },
638 },
639 },
640 &quot;kind&quot;: &quot;compute#interconnectAttachmentAggregatedList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#interconnectAttachmentAggregatedList for aggregated
641 # lists of interconnect attachments.
642 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
643 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
644 # the query parameter pageToken in the next list request.
645 # Subsequent list requests will have their own nextPageToken to
646 # continue paging through the results.
647 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
648 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
649 &quot;A String&quot;,
650 ],
651 &quot;warning&quot;: { # [Output Only] Informational warning message.
652 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
653 # Engine returns NO_RESULTS_ON_PAGE if there
654 # are no results in the response.
655 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
656 # value format. For example:
657 #
658 # &quot;data&quot;: [
659 # {
660 # &quot;key&quot;: &quot;scope&quot;,
661 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
662 # }
663 {
664 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
665 # returned. For example, for warnings where there are no results in a list
666 # request for a particular zone, this key might be scope and
667 # the key value might be the zone name. Other examples might be a key
668 # indicating a deprecated resource and a suggested replacement, or a
669 # warning about invalid network settings (for example, if an instance
670 # attempts to perform IP forwarding but is not enabled for IP forwarding).
671 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
672 },
673 ],
674 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
675 },
676 }</pre>
677 </div>
678
679 <div class="method">
680 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
681 <pre>Retrieves the next page of results.
682
683 Args:
684 previous_request: The request for the previous page. (required)
685 previous_response: The response from the request for the previous page. (required)
686
687 Returns:
688 A request object that you can call &#x27;execute()&#x27; on to request the next
689 page. Returns None if there are no more items in the collection.
690 </pre>
691 </div>
692
693 <div class="method">
694 <code class="details" id="close">close()</code>
695 <pre>Close httplib2 connections.</pre>
696 </div>
697
698 <div class="method">
699 <code class="details" id="delete">delete(project, region, interconnectAttachment, requestId=None, x__xgafv=None)</code>
700 <pre>Deletes the specified interconnect attachment.
701
702 Args:
703 project: string, Project ID for this request. (required)
704 region: string, Name of the region for this request. (required)
705 interconnectAttachment: string, Name of the interconnect attachment to delete. (required)
706 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
707 that if you must retry your request, the server will know to ignore the
708 request if it has already been completed.
709
710 For example, consider a situation where you make an initial request and
711 the request times out. If you make the request again with the same
712 request ID, the server can check if original operation with the same
713 request ID was received, and if so, will ignore the second request. This
714 prevents clients from accidentally creating duplicate commitments.
715
716 The request ID must be
717 a valid UUID with the exception that zero UUID is not supported
718 (00000000-0000-0000-0000-000000000000).
719 x__xgafv: string, V1 error format.
720 Allowed values
721 1 - v1 error format
722 2 - v2 error format
723
724 Returns:
725 An object of the form:
726
727 { # Represents an Operation resource.
728 #
729 # Google Compute Engine has three Operation resources:
730 #
731 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
732 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
733 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
734 #
735 # You can use an operation resource to manage asynchronous API requests.
736 # For more information, readHandling
737 # API responses.
738 #
739 # Operations can be global, regional or zonal.
740 #
741 # - For global operations, use the `globalOperations`
742 # resource.
743 # - For regional operations, use the
744 # `regionOperations` resource.
745 # - For zonal operations, use
746 # the `zoneOperations` resource.
747 #
748 #
749 #
750 # For more information, read
751 # Global, Regional, and Zonal Resources.
752 #
753 # Note that completed Operation resources have a limited
754 # retention period.
755 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
756 # Not present otherwise.
757 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
758 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
759 # set when the operation is created.
760 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
761 # text format.
762 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
763 # this field will be populated.
764 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
765 # operation.
766 {
767 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
768 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
769 # details. There is a set of defined message types to use for providing
770 # details.The syntax depends on the error code. For example,
771 # QuotaExceededInfo will have details when the error code is
772 # QUOTA_EXCEEDED.
773 {
774 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
775 #
776 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
777 # is not enabled:
778 #
779 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
780 # &quot;domain&quot;: &quot;googleapis.com&quot;
781 # &quot;metadata&quot;: {
782 # &quot;resource&quot;: &quot;projects/123&quot;,
783 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
784 # }
785 # }
786 #
787 # This response indicates that the pubsub.googleapis.com API is not enabled.
788 #
789 # Example of an error that is returned when attempting to create a Spanner
790 # instance in a region that is out of stock:
791 #
792 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
793 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
794 # &quot;metadata&quot;: {
795 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
796 # }
797 # }
798 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
799 # is typically the registered service name of the tool or product that
800 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
801 # generated by some common infrastructure, the error domain must be a
802 # globally unique value that identifies the infrastructure. For Google API
803 # infrastructure, the error domain is &quot;googleapis.com&quot;.
804 &quot;metadatas&quot;: { # Additional structured details about this error.
805 #
806 # Keys must match a regular expression of `a-z+` but should
807 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
808 # length. When identifying the current value of an exceeded limit, the units
809 # should be contained in the key, not the value. For example, rather than
810 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
811 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
812 # instances that can be created in a single (batch) request.
813 &quot;a_key&quot;: &quot;A String&quot;,
814 },
815 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
816 # proximate cause of the error. Error reasons are unique within a particular
817 # domain of errors. This should be at most 63 characters and match a
818 # regular expression of `A-Z+[A-Z0-9]`, which represents
819 # UPPER_SNAKE_CASE.
820 },
821 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
822 #
823 # For example, if a quota check failed with an error indicating the calling
824 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
825 # directly to the right place in the developer console to flip the bit.
826 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
827 { # Describes a URL link.
828 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
829 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
830 },
831 ],
832 },
833 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
834 # which can be attached to an RPC error.
835 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
836 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
837 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
838 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
839 },
840 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
841 &quot;dimensions&quot;: { # The map holding related quota dimensions.
842 &quot;a_key&quot;: &quot;A String&quot;,
843 },
844 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
845 # type or metric.
846 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
847 # or metric.
848 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
849 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
850 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
851 },
852 },
853 ],
854 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
855 # This property is optional.
856 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
857 },
858 ],
859 },
860 &quot;getVersionOperationMetadata&quot;: {
861 &quot;inlineSbomInfo&quot;: {
862 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
863 # appropriate identifiers.
864 &quot;a_key&quot;: &quot;A String&quot;,
865 },
866 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
867 # identifiers.
868 &quot;a_key&quot;: &quot;A String&quot;,
869 },
870 },
871 },
872 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
873 # message that was returned, such as `NOT FOUND`.
874 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
875 # status code that was returned. For example, a `404` means the
876 # resource was not found.
877 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
878 # defined by the server.
879 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
880 # This value is inRFC3339
881 # text format.
882 &quot;instancesBulkInsertOperationMetadata&quot;: {
883 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
884 # Example key: zones/us-central1-a
885 &quot;a_key&quot;: {
886 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
887 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
888 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
889 # error.
890 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
891 # if the flow is rolling forward or rolling back.
892 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
893 },
894 },
895 },
896 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
897 # Operation resources.
898 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
899 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
900 # group of operations results from a `bulkInsert` API request.
901 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
902 # `update`, or `delete`, and so on.
903 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
904 # There is no requirement that this be linear or support any granularity of
905 # operations. This should not be used to guess when the operation will be
906 # complete. This number should monotonically increase as the operation
907 # progresses.
908 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
909 # applicable when performing regional operations.
910 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
911 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
912 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
913 # this field will contain information on all underlying zonal actions and
914 # their state.
915 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
916 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
917 # Example key: zones/us-central1-a
918 &quot;a_key&quot;: {
919 &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
920 # populated.
921 # different programming environments, including REST APIs and RPC APIs. It is
922 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
923 # three pieces of data: error code, error message, and error details.
924 #
925 # You can find out more about this error model and how to work with it in the
926 # [API Design Guide](https://cloud.google.com/apis/design/errors).
927 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
928 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
929 # message types for APIs to use.
930 {
931 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
932 },
933 ],
934 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
935 # user-facing error message should be localized and sent in the
936 # google.rpc.Status.details field, or localized by the client.
937 },
938 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
939 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
940 },
941 },
942 },
943 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
944 # This value is inRFC3339
945 # text format.
946 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
947 # following:
948 # `PENDING`, `RUNNING`, or `DONE`.
949 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
950 # operation.
951 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
952 # of the target resource.
953 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
954 # operations related to creating a snapshot, this points to the disk
955 # that the snapshot was created from.
956 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
957 # `[email protected]` or
958 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
959 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
960 # operation, this field will be populated.
961 {
962 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
963 # Engine returns NO_RESULTS_ON_PAGE if there
964 # are no results in the response.
965 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
966 # value format. For example:
967 #
968 # &quot;data&quot;: [
969 # {
970 # &quot;key&quot;: &quot;scope&quot;,
971 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
972 # }
973 {
974 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
975 # returned. For example, for warnings where there are no results in a list
976 # request for a particular zone, this key might be scope and
977 # the key value might be the zone name. Other examples might be a key
978 # indicating a deprecated resource and a suggested replacement, or a
979 # warning about invalid network settings (for example, if an instance
980 # attempts to perform IP forwarding but is not enabled for IP forwarding).
981 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
982 },
983 ],
984 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
985 },
986 ],
987 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
988 # applicable when performing per-zone operations.
989 }</pre>
990 </div>
991
992 <div class="method">
993 <code class="details" id="get">get(project, region, interconnectAttachment, x__xgafv=None)</code>
994 <pre>Returns the specified interconnect attachment.
995
996 Args:
997 project: string, Project ID for this request. (required)
998 region: string, Name of the region for this request. (required)
999 interconnectAttachment: string, Name of the interconnect attachment to return. (required)
1000 x__xgafv: string, V1 error format.
1001 Allowed values
1002 1 - v1 error format
1003 2 - v2 error format
1004
1005 Returns:
1006 An object of the form:
1007
1008 { # Represents an Interconnect Attachment (VLAN) resource.
1009 #
1010 # You can use Interconnect attachments (VLANS) to connect your Virtual Private
1011 # Cloud networks to your on-premises networks through an Interconnect.
1012 # For more information, read
1013 # Creating VLAN Attachments.
1014 &quot;adminEnabled&quot;: True or False, # Determines whether this Attachment will carry packets.
1015 # Not present for PARTNER_PROVIDER.
1016 &quot;attachmentGroup&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the AttachmentGroup that includes this Attachment.
1017 &quot;bandwidth&quot;: &quot;A String&quot;, # Provisioned bandwidth capacity for the interconnect attachment. For
1018 # attachments of type DEDICATED, the user can set the bandwidth.
1019 # For attachments of type PARTNER, the Google Partner that is operating
1020 # the interconnect must set the bandwidth.
1021 # Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED,
1022 # and can take one of the following values:
1023 #
1024 # - BPS_50M: 50 Mbit/s
1025 # - BPS_100M: 100 Mbit/s
1026 # - BPS_200M: 200 Mbit/s
1027 # - BPS_300M: 300 Mbit/s
1028 # - BPS_400M: 400 Mbit/s
1029 # - BPS_500M: 500 Mbit/s
1030 # - BPS_1G: 1 Gbit/s
1031 # - BPS_2G: 2 Gbit/s
1032 # - BPS_5G: 5 Gbit/s
1033 # - BPS_10G: 10 Gbit/s
1034 # - BPS_20G: 20 Gbit/s
1035 # - BPS_50G: 50 Gbit/s
1036 # - BPS_100G: 100 Gbit/s
1037 # - BPS_400G: 400 Gbit/s
1038 &quot;candidateCloudRouterIpAddress&quot;: &quot;A String&quot;, # Single IPv4 address + prefix length to be configured on the cloud router
1039 # interface for this interconnect attachment.
1040 #
1041 # - Both candidate_cloud_router_ip_address and
1042 # candidate_customer_router_ip_address fields must be set or both must be
1043 # unset.
1044 # - Prefix length of both candidate_cloud_router_ip_address and
1045 # candidate_customer_router_ip_address must be the same.
1046 # - Max prefix length is 31.
1047 &quot;candidateCloudRouterIpv6Address&quot;: &quot;A String&quot;, # Single IPv6 address + prefix length to be configured on the cloud router
1048 # interface for this interconnect attachment.
1049 #
1050 # - Both candidate_cloud_router_ipv6_address and
1051 # candidate_customer_router_ipv6_address fields must be set or both must be
1052 # unset.
1053 # - Prefix length of both candidate_cloud_router_ipv6_address and
1054 # candidate_customer_router_ipv6_address must be the same.
1055 # - Max prefix length is 126.
1056 &quot;candidateCustomerRouterIpAddress&quot;: &quot;A String&quot;, # Single IPv4 address + prefix length to be configured on the customer router
1057 # interface for this interconnect attachment.
1058 &quot;candidateCustomerRouterIpv6Address&quot;: &quot;A String&quot;, # Single IPv6 address + prefix length to be configured on the customer router
1059 # interface for this interconnect attachment.
1060 &quot;candidateIpv6Subnets&quot;: [ # This field is not available.
1061 &quot;A String&quot;,
1062 ],
1063 &quot;candidateSubnets&quot;: [ # Input only. Up to 16 candidate prefixes that can be used to restrict the allocation
1064 # of cloudRouterIpAddress and customerRouterIpAddress for this attachment.
1065 # All prefixes must be within link-local address space (169.254.0.0/16) and
1066 # must be /29 or shorter (/28, /27, etc). Google will attempt to select an
1067 # unused /29 from the supplied candidate prefix(es). The request will fail if
1068 # all possible /29s are in use on Google&#x27;s edge. If not supplied, Google will
1069 # randomly select an unused /29 from all of link-local space.
1070 &quot;A String&quot;,
1071 ],
1072 &quot;cloudRouterIpAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IPv4 address + prefix length to be configured on Cloud Router
1073 # Interface for this interconnect attachment.
1074 &quot;cloudRouterIpv6Address&quot;: &quot;A String&quot;, # Output only. [Output Only] IPv6 address + prefix length to be configured on Cloud
1075 # Router Interface for this interconnect attachment.
1076 &quot;cloudRouterIpv6InterfaceId&quot;: &quot;A String&quot;, # This field is not available.
1077 &quot;configurationConstraints&quot;: { # Output only. [Output Only] Constraints for this attachment, if any. The attachment does
1078 # not work if these constraints are not met.
1079 &quot;bgpMd5&quot;: &quot;A String&quot;, # Output only. [Output Only] Whether the attachment&#x27;s BGP session
1080 # requires/allows/disallows BGP MD5 authentication. This can take one of
1081 # the following values: MD5_OPTIONAL, MD5_REQUIRED, MD5_UNSUPPORTED.
1082 #
1083 # For example, a Cross-Cloud Interconnect connection to a remote cloud
1084 # provider that requires BGP MD5 authentication has the
1085 # interconnectRemoteLocation attachment_configuration_constraints.bgp_md5
1086 # field set to MD5_REQUIRED, and that property is propagated to the
1087 # attachment. Similarly, if BGP MD5 is MD5_UNSUPPORTED, an error is
1088 # returned if MD5 is requested.
1089 &quot;bgpPeerAsnRanges&quot;: [ # Output only. [Output Only] List of ASN ranges that the remote location is known to
1090 # support. Formatted as an array of inclusive ranges {min: min-value, max:
1091 # max-value}. For example, [{min: 123, max: 123}, {min: 64512, max: 65534}]
1092 # allows the peer ASN to be 123 or anything in the range 64512-65534.
1093 #
1094 # This field is only advisory. Although the API accepts other ranges, these
1095 # are the ranges that we recommend.
1096 {
1097 &quot;max&quot;: 42,
1098 &quot;min&quot;: 42,
1099 },
1100 ],
1101 },
1102 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1103 # text format.
1104 &quot;customerRouterIpAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IPv4 address + prefix length to be configured on the customer
1105 # router subinterface for this interconnect attachment.
1106 &quot;customerRouterIpv6Address&quot;: &quot;A String&quot;, # Output only. [Output Only] IPv6 address + prefix length to be configured on the
1107 # customer router subinterface for this interconnect attachment.
1108 &quot;customerRouterIpv6InterfaceId&quot;: &quot;A String&quot;, # This field is not available.
1109 &quot;dataplaneVersion&quot;: 42, # Output only. [Output Only] Dataplane version for this InterconnectAttachment. This
1110 # field is only present for Dataplane version 2 and higher. Absence of this
1111 # field in the API output indicates that the Dataplane is version 1.
1112 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource.
1113 &quot;edgeAvailabilityDomain&quot;: &quot;A String&quot;, # Input only. Desired availability domain for the attachment. Only available for type
1114 # PARTNER, at creation time, and can take one of the following values:
1115 #
1116 # - AVAILABILITY_DOMAIN_ANY
1117 # - AVAILABILITY_DOMAIN_1
1118 # - AVAILABILITY_DOMAIN_2
1119 #
1120 #
1121 # For improved reliability, customers should configure a pair of attachments,
1122 # one per availability domain. The selected availability domain will be
1123 # provided to the Partner via the pairing key, so that the provisioned
1124 # circuit will lie in the specified domain. If not specified, the value will
1125 # default to AVAILABILITY_DOMAIN_ANY.
1126 &quot;encryption&quot;: &quot;A String&quot;, # Indicates the user-supplied encryption option of this VLAN attachment
1127 # (interconnectAttachment). Can only be specified at attachment creation
1128 # for PARTNER or DEDICATED attachments.
1129 # Possible values are:
1130 #
1131 # - NONE - This is the default value, which means that the
1132 # VLAN attachment carries unencrypted traffic. VMs are able to send
1133 # traffic to, or receive traffic from, such a VLAN attachment.
1134 # - IPSEC - The VLAN attachment carries only encrypted
1135 # traffic that is encrypted by an IPsec device, such as an HA VPN gateway or
1136 # third-party IPsec VPN. VMs cannot directly send traffic to, or receive
1137 # traffic from, such a VLAN attachment. To use *HA VPN over Cloud
1138 # Interconnect*, the VLAN attachment must be created with this
1139 # option.
1140 &quot;googleReferenceId&quot;: &quot;A String&quot;, # Output only. [Output Only] Google reference ID, to be used when raising support tickets
1141 # with Google or otherwise to debug backend connectivity issues.
1142 # [Deprecated] This field is not used.
1143 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1144 # defined by the server.
1145 &quot;interconnect&quot;: &quot;A String&quot;, # URL of the underlying Interconnect object that this attachment&#x27;s traffic
1146 # will traverse through.
1147 &quot;ipsecInternalAddresses&quot;: [ # A list of URLs of addresses that have been reserved for the VLAN
1148 # attachment. Used only for the VLAN attachment that has the encryption
1149 # option as IPSEC. The addresses must be regional internal IP address ranges.
1150 # When creating an HA VPN gateway over the VLAN attachment, if the attachment
1151 # is configured to use a regional internal IP address, then the VPN gateway&#x27;s
1152 # IP address is allocated from the IP address range specified here. For
1153 # example, if the HA VPN gateway&#x27;s interface 0 is paired to this VLAN
1154 # attachment, then a regional internal IP address for the VPN gateway
1155 # interface 0 will be allocated from the IP address specified for this
1156 # VLAN attachment.
1157 # If this field is not specified when creating the VLAN attachment, then
1158 # later on when creating an HA VPN gateway on this VLAN attachment, the HA
1159 # VPN gateway&#x27;s IP address is allocated from the regional external IP address
1160 # pool.
1161 &quot;A String&quot;,
1162 ],
1163 &quot;kind&quot;: &quot;compute#interconnectAttachment&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#interconnectAttachment for interconnect attachments.
1164 &quot;l2Forwarding&quot;: { # L2 Interconnect Attachment related configuration. # L2 Interconnect Attachment related config. This field is required if the
1165 # type is L2_DEDICATED.
1166 #
1167 # The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad)
1168 # within L2 packets are mapped to the destination appliances IP addresses.
1169 # The packet is then encapsulated with the appliance IP address and sent to
1170 # the edge appliance.
1171 &quot;applianceMappings&quot;: { # Optional. A map of VLAN tags to appliances and optional inner mapping
1172 # rules. If VLANs are not explicitly mapped to any appliance, the
1173 # defaultApplianceIpAddress is used.
1174 #
1175 # Each VLAN tag can be a single number or a range of numbers in the range
1176 # of 1 to 4094, e.g., &quot;1&quot; or &quot;4001-4094&quot;. Non-empty and non-overlapping
1177 # VLAN tag ranges are enforced, and violating operations will be rejected.
1178 #
1179 # The VLAN tags in the Ethernet header must use an ethertype value of
1180 # 0x88A8 or 0x8100.
1181 &quot;a_key&quot;: { # Two-level VLAN-to-Appliance mapping rule.
1182 &quot;applianceIpAddress&quot;: &quot;A String&quot;, # Optional. A single IPv4 or IPv6 address used as the destination IP
1183 # address for ingress packets that match on a VLAN tag, but do not match
1184 # a more specific inner VLAN tag.
1185 #
1186 # Unset field (null-value) indicates both VLAN tags are required to be
1187 # mapped. Otherwise, defaultApplianceIpAddress is used.
1188 &quot;innerVlanToApplianceMappings&quot;: [ # Optional. Used to match against the inner VLAN when the packet
1189 # contains two VLAN tags.
1190 #
1191 # A list of mapping rules from inner VLAN tags to IP addresses. If the
1192 # inner VLAN is not explicitly mapped to an IP address range, the
1193 # applianceIpAddress is used.
1194 { # The inner VLAN-to-Appliance mapping.
1195 &quot;innerApplianceIpAddress&quot;: &quot;A String&quot;, # Required in this object. A single IPv4 or IPv6 address used as the
1196 # destination IP address for ingress packets that match on both VLAN
1197 # tags.
1198 &quot;innerVlanTags&quot;: [ # Required in this object. Used to match the inner VLAN tag on the
1199 # packet. Each entry can be a single number or a range of numbers in
1200 # the range of 1 to 4094, e.g., [&quot;1&quot;, &quot;4001-4094&quot;] is valid. Non-empty
1201 # and Non-overlapping VLAN tag ranges are enforced, and violating
1202 # operations will be rejected.
1203 #
1204 # The inner VLAN tags must have an ethertype value of 0x8100.
1205 &quot;A String&quot;,
1206 ],
1207 },
1208 ],
1209 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of this appliance mapping rule.
1210 },
1211 },
1212 &quot;defaultApplianceIpAddress&quot;: &quot;A String&quot;, # Optional. A single IPv4 or IPv6 address used as the default destination
1213 # IP when there is no VLAN mapping result found.
1214 #
1215 # Unset field (null-value) indicates the unmatched packet should be
1216 # dropped.
1217 &quot;geneveHeader&quot;: { # GeneveHeader related configurations. # Optional. It represents the structure of a Geneve (Generic Network
1218 # Virtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various
1219 # protocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization
1220 # environments.
1221 &quot;vni&quot;: 42, # Optional. VNI is a 24-bit unique virtual network identifier, from 0 to
1222 # 16,777,215.
1223 },
1224 &quot;network&quot;: &quot;A String&quot;, # Required. Resource URL of the network to which this attachment belongs.
1225 &quot;tunnelEndpointIpAddress&quot;: &quot;A String&quot;, # Required. A single IPv4 or IPv6 address. This address will be used as the
1226 # source IP address for packets sent to the appliances, and must be used as
1227 # the destination IP address for packets that should be sent out through
1228 # this attachment.
1229 },
1230 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this InterconnectAttachment,
1231 # which is essentially a hash of the labels set used for optimistic locking.
1232 # The fingerprint is initially generated by Compute Engine and changes after
1233 # every request to modify or update labels. You must always provide an
1234 # up-to-date fingerprint hash in order to update or change labels,
1235 # otherwise the request will fail with error412 conditionNotMet.
1236 #
1237 # To see the latest fingerprint, make a get() request to
1238 # retrieve an InterconnectAttachment.
1239 &quot;labels&quot;: { # Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
1240 # Label values may be empty.
1241 &quot;a_key&quot;: &quot;A String&quot;,
1242 },
1243 &quot;mtu&quot;: 42, # Maximum Transmission Unit (MTU), in bytes, of packets passing through this
1244 # interconnect attachment.
1245 # Valid values are 1440, 1460, 1500, and 8896. If not specified,
1246 # the value will default to 1440.
1247 &quot;multicastEnabled&quot;: True or False, # Whether or not to permit multicast traffic for this attachment. Multicast
1248 # packets will be dropped if this is not enabled.
1249 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1250 # The name must be 1-63 characters long, and comply withRFC1035.
1251 # Specifically, the name must be 1-63 characters long and match the regular
1252 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1253 # character must be a lowercase letter, and all following characters must
1254 # be a dash, lowercase letter, or digit, except the last character, which
1255 # cannot be a dash.
1256 &quot;operationalStatus&quot;: &quot;A String&quot;, # Output only. [Output Only] The current status of whether or not this interconnect
1257 # attachment is functional, which can take one of the following values:
1258 #
1259 # - OS_ACTIVE: The attachment has been turned up and is ready to
1260 # use.
1261 # - OS_UNPROVISIONED: The attachment is not ready to use yet,
1262 # because turnup is not complete.
1263 &quot;pairingKey&quot;: &quot;A String&quot;, # [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not
1264 # present for DEDICATED].
1265 # The opaque identifier of a PARTNER attachment used to initiate
1266 # provisioning with a selected partner.
1267 # Of the form &quot;XXXXX/region/domain&quot;
1268 &quot;params&quot;: { # Additional interconnect attachment parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
1269 # as part of resource payload.
1270 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
1271 # Tag keys and values have the same definition as resource
1272 # manager tags. The field is allowed for INSERT
1273 # only. The keys/values to set on the resource should be specified in
1274 # either ID { : } or Namespaced format
1275 # { : }.
1276 # For example the following are valid inputs:
1277 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
1278 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
1279 # Note:
1280 # * Invalid combinations of ID &amp; namespaced format is not supported. For
1281 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
1282 # * Inconsistent format is not supported. For instance:
1283 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
1284 &quot;a_key&quot;: &quot;A String&quot;,
1285 },
1286 },
1287 &quot;partnerAsn&quot;: &quot;A String&quot;, # Optional BGP ASN for the router supplied by a Layer 3 Partner if they
1288 # configured BGP on behalf of the customer.
1289 # Output only for PARTNER type, input only for PARTNER_PROVIDER, not
1290 # available for DEDICATED.
1291 &quot;partnerMetadata&quot;: { # Informational metadata about Partner attachments from Partners to display # Informational metadata about Partner attachments from Partners to display
1292 # to customers.
1293 # Output only for PARTNER type, mutable for PARTNER_PROVIDER, not
1294 # available for DEDICATED.
1295 # to customers. These fields are propagated from PARTNER_PROVIDER
1296 # attachments to their corresponding PARTNER attachments.
1297 &quot;interconnectName&quot;: &quot;A String&quot;, # Plain text name of the Interconnect this attachment is connected to, as
1298 # displayed in the Partner&#x27;s portal. For instance &quot;Chicago 1&quot;.
1299 # This value may be validated to match approved Partner values.
1300 &quot;partnerName&quot;: &quot;A String&quot;, # Plain text name of the Partner providing this attachment.
1301 # This value may be validated to match approved Partner values.
1302 &quot;portalUrl&quot;: &quot;A String&quot;, # URL of the Partner&#x27;s portal for this Attachment. Partners may customise
1303 # this to be a deep link to the specific resource on the Partner portal.
1304 # This value may be validated to match approved Partner values.
1305 },
1306 &quot;privateInterconnectInfo&quot;: { # Information for an interconnect attachment when this belongs to an # Output only. [Output Only] Information specific to an InterconnectAttachment.
1307 # This property is populated if the interconnect that
1308 # this is attached to is of type DEDICATED.
1309 # interconnect of type DEDICATED.
1310 &quot;tag8021q&quot;: 42, # [Output Only] 802.1q encapsulation tag to be used for traffic between
1311 # Google and the customer, going to and from this network and region.
1312 },
1313 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional interconnect attachment
1314 # resides.
1315 # You must specify this field as part of the HTTP request URL. It is
1316 # not settable as a field in the request body.
1317 &quot;remoteService&quot;: &quot;A String&quot;, # Output only. [Output Only]
1318 # If the attachment is on a Cross-Cloud Interconnect connection, this field
1319 # contains the interconnect&#x27;s remote location service provider. Example
1320 # values: &quot;Amazon Web Services&quot; &quot;Microsoft Azure&quot;.
1321 #
1322 # The field is set only for attachments on Cross-Cloud Interconnect
1323 # connections. Its value is copied from the InterconnectRemoteLocation
1324 # remoteService field.
1325 &quot;router&quot;: &quot;A String&quot;, # URL of the Cloud Router to be used for dynamic routing. This router must be
1326 # in the same region as this InterconnectAttachment. The
1327 # InterconnectAttachment will automatically connect the Interconnect to the
1328 # network &amp; region within which the Cloud Router is configured.
1329 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
1330 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1331 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1332 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this interconnect attachment to identify whether the
1333 # IPv6 feature is enabled or not. If not specified, IPV4_ONLY
1334 # will be used.
1335 #
1336 # This field can be both set at interconnect attachments creation and
1337 # update interconnect attachment operations.
1338 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The current state of this attachment&#x27;s functionality.
1339 # Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE,
1340 # PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values
1341 # PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used
1342 # for only PARTNER and PARTNER_PROVIDER interconnect attachments.
1343 # This state can take one of the following values:
1344 #
1345 # - ACTIVE: The attachment has been turned up and is ready to use.
1346 # - UNPROVISIONED: The attachment is not ready to use yet, because turnup
1347 # is not complete.
1348 # - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet
1349 # been configured on the Partner side.
1350 # - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of
1351 # provisioning after a PARTNER_PROVIDER attachment was created that
1352 # references it.
1353 # - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER
1354 # attachment that is waiting for a customer to activate it.
1355 # - DEFUNCT:
1356 # The attachment was deleted externally and is no longer functional. This
1357 # could be because the associated Interconnect was removed, or because the
1358 # other side of a Partner attachment was deleted.
1359 &quot;subnetLength&quot;: 42, # Input only. Length of the IPv4 subnet mask.
1360 # Allowed values:
1361 #
1362 #
1363 # - 29 (default)
1364 # - 30
1365 #
1366 # The default value is 29, except for Cross-Cloud Interconnect
1367 # connections that use an InterconnectRemoteLocation with a
1368 # constraints.subnetLengthRange.min equal to 30. For example,
1369 # connections that use an Azure remote location fall into this
1370 # category. In these cases, the default value is 30, and requesting
1371 # 29 returns an error.
1372 #
1373 # Where both 29 and 30 are allowed, 29 is preferred, because it gives
1374 # Google Cloud Support more debugging visibility.
1375 &quot;type&quot;: &quot;A String&quot;, # The type of interconnect attachment this is, which can take one of the
1376 # following values:
1377 #
1378 # - DEDICATED: an attachment to a Dedicated Interconnect.
1379 # - PARTNER: an attachment to a Partner Interconnect, created by the
1380 # customer.
1381 # - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by
1382 # the partner.
1383 #
1384 # - L2_DEDICATED: a L2 attachment to a Dedicated Interconnect.
1385 &quot;vlanTag8021q&quot;: 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093.
1386 # Only specified at creation time.
1387 }</pre>
1388 </div>
1389
1390 <div class="method">
1391 <code class="details" id="getIamPolicy">getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
1392 <pre>Gets the access control policy for a resource. May be empty if no such
1393 policy or resource exists.
1394
1395 Args:
1396 project: string, Project ID for this request. (required)
1397 region: string, The name of the region for this request. (required)
1398 resource: string, Name or id of the resource for this request. (required)
1399 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
1400 x__xgafv: string, V1 error format.
1401 Allowed values
1402 1 - v1 error format
1403 2 - v2 error format
1404
1405 Returns:
1406 An object of the form:
1407
1408 { # An Identity and Access Management (IAM) policy, which specifies access
1409 # controls for Google Cloud resources.
1410 #
1411 #
1412 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
1413 # `members`, or principals, to a single `role`. Principals can be user
1414 # accounts, service accounts, Google groups, and domains (such as G Suite). A
1415 # `role` is a named list of permissions; each `role` can be an IAM predefined
1416 # role or a user-created custom role.
1417 #
1418 # For some types of Google Cloud resources, a `binding` can also specify a
1419 # `condition`, which is a logical expression that allows access to a resource
1420 # only if the expression evaluates to `true`. A condition can add constraints
1421 # based on attributes of the request, the resource, or both. To learn which
1422 # resources support conditions in their IAM policies, see the
1423 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1424 #
1425 # **JSON example:**
1426 #
1427 # ```
1428 # {
1429 # &quot;bindings&quot;: [
1430 # {
1431 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
1432 # &quot;members&quot;: [
1433 # &quot;user:[email protected]&quot;,
1434 # &quot;group:[email protected]&quot;,
1435 # &quot;domain:google.com&quot;,
1436 # &quot;serviceAccount:[email protected]&quot;
1437 # ]
1438 # },
1439 # {
1440 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
1441 # &quot;members&quot;: [
1442 # &quot;user:[email protected]&quot;
1443 # ],
1444 # &quot;condition&quot;: {
1445 # &quot;title&quot;: &quot;expirable access&quot;,
1446 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
1447 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
1448 # }
1449 # }
1450 # ],
1451 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
1452 # &quot;version&quot;: 3
1453 # }
1454 # ```
1455 #
1456 # **YAML example:**
1457 #
1458 # ```
1459 # bindings:
1460 # - members:
1461 # - user:[email protected]
1462 # - group:[email protected]
1463 # - domain:google.com
1464 # - serviceAccount:[email protected]
1465 # role: roles/resourcemanager.organizationAdmin
1466 # - members:
1467 # - user:[email protected]
1468 # role: roles/resourcemanager.organizationViewer
1469 # condition:
1470 # title: expirable access
1471 # description: Does not grant access after Sep 2020
1472 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
1473 # etag: BwWWja0YfJA=
1474 # version: 3
1475 # ```
1476 #
1477 # For a description of IAM and its features, see the
1478 # [IAM documentation](https://cloud.google.com/iam/docs/).
1479 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
1480 { # Specifies the audit configuration for a service.
1481 # The configuration determines which permission types are logged, and what
1482 # identities, if any, are exempted from logging.
1483 # An AuditConfig must have one or more AuditLogConfigs.
1484 #
1485 # If there are AuditConfigs for both `allServices` and a specific service,
1486 # the union of the two AuditConfigs is used for that service: the log_types
1487 # specified in each AuditConfig are enabled, and the exempted_members in each
1488 # AuditLogConfig are exempted.
1489 #
1490 # Example Policy with multiple AuditConfigs:
1491 #
1492 # {
1493 # &quot;audit_configs&quot;: [
1494 # {
1495 # &quot;service&quot;: &quot;allServices&quot;,
1496 # &quot;audit_log_configs&quot;: [
1497 # {
1498 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1499 # &quot;exempted_members&quot;: [
1500 # &quot;user:[email protected]&quot;
1501 # ]
1502 # },
1503 # {
1504 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1505 # },
1506 # {
1507 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
1508 # }
1509 # ]
1510 # },
1511 # {
1512 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
1513 # &quot;audit_log_configs&quot;: [
1514 # {
1515 # &quot;log_type&quot;: &quot;DATA_READ&quot;
1516 # },
1517 # {
1518 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
1519 # &quot;exempted_members&quot;: [
1520 # &quot;user:[email protected]&quot;
1521 # ]
1522 # }
1523 # ]
1524 # }
1525 # ]
1526 # }
1527 #
1528 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1529 # logging. It also exempts `[email protected]` from DATA_READ logging, and
1530 # `[email protected]` from DATA_WRITE logging.
1531 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
1532 { # Provides the configuration for logging a type of permissions.
1533 # Example:
1534 #
1535 # {
1536 # &quot;audit_log_configs&quot;: [
1537 # {
1538 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1539 # &quot;exempted_members&quot;: [
1540 # &quot;user:[email protected]&quot;
1541 # ]
1542 # },
1543 # {
1544 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1545 # }
1546 # ]
1547 # }
1548 #
1549 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
1550 # [email protected] from DATA_READ logging.
1551 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
1552 # permission.
1553 # Follows the same format of Binding.members.
1554 &quot;A String&quot;,
1555 ],
1556 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
1557 },
1558 ],
1559 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
1560 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
1561 # `allServices` is a special value that covers all services.
1562 },
1563 ],
1564 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
1565 # may specify a `condition` that determines how and when the `bindings` are
1566 # applied. Each of the `bindings` must contain at least one principal.
1567 #
1568 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
1569 # of these principals can be Google groups. Each occurrence of a principal
1570 # counts towards these limits. For example, if the `bindings` grant 50
1571 # different roles to `user:[email protected]`, and not to any other
1572 # principal, then you can add another 1,450 principals to the `bindings` in
1573 # the `Policy`.
1574 { # Associates `members`, or principals, with a `role`.
1575 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1576 #
1577 # If the condition evaluates to `true`, then this binding applies to the
1578 # current request.
1579 #
1580 # If the condition evaluates to `false`, then this binding does not apply to
1581 # the current request. However, a different role binding might grant the same
1582 # role to one or more of the principals in this binding.
1583 #
1584 # To learn which resources support conditions in their IAM policies, see the
1585 # [IAM
1586 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1587 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1588 # are documented at https://github.com/google/cel-spec.
1589 #
1590 # Example (Comparison):
1591 #
1592 # title: &quot;Summary size limit&quot;
1593 # description: &quot;Determines if a summary is less than 100 chars&quot;
1594 # expression: &quot;document.summary.size() &lt; 100&quot;
1595 #
1596 # Example (Equality):
1597 #
1598 # title: &quot;Requestor is owner&quot;
1599 # description: &quot;Determines if requestor is the document owner&quot;
1600 # expression: &quot;document.owner == request.auth.claims.email&quot;
1601 #
1602 # Example (Logic):
1603 #
1604 # title: &quot;Public documents&quot;
1605 # description: &quot;Determine whether the document should be publicly visible&quot;
1606 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
1607 #
1608 # Example (Data Manipulation):
1609 #
1610 # title: &quot;Notification string&quot;
1611 # description: &quot;Create a notification string with a timestamp.&quot;
1612 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
1613 #
1614 # The exact variables and functions that may be referenced within an expression
1615 # are determined by the service that evaluates it. See the service
1616 # documentation for additional information.
1617 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
1618 # describes the expression, e.g. when hovered over it in a UI.
1619 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
1620 # syntax.
1621 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
1622 # reporting, e.g. a file name and a position in the file.
1623 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
1624 # its purpose. This can be used e.g. in UIs which allow to enter the
1625 # expression.
1626 },
1627 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
1628 # `members` can have the following values:
1629 #
1630 # * `allUsers`: A special identifier that represents anyone who is
1631 # on the internet; with or without a Google account.
1632 #
1633 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1634 # who is authenticated with a Google account or a service account.
1635 # Does not include identities that come from external identity providers
1636 # (IdPs) through identity federation.
1637 #
1638 # * `user:{emailid}`: An email address that represents a specific Google
1639 # account. For example, `[email protected]` .
1640 #
1641 #
1642 # * `serviceAccount:{emailid}`: An email address that represents a Google
1643 # service account. For example,
1644 # `[email protected]`.
1645 #
1646 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
1647 # identifier for a
1648 # [Kubernetes service
1649 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
1650 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
1651 #
1652 # * `group:{emailid}`: An email address that represents a Google group.
1653 # For example, `[email protected]`.
1654 #
1655 #
1656 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1657 # users of that domain. For example, `google.com` or `example.com`.
1658 #
1659 #
1660 #
1661 #
1662 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1663 # A single identity in a workforce identity pool.
1664 #
1665 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
1666 # All workforce identities in a group.
1667 #
1668 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1669 # All workforce identities with a specific attribute value.
1670 #
1671 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
1672 # All identities in a workforce identity pool.
1673 #
1674 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
1675 # A single identity in a workload identity pool.
1676 #
1677 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
1678 # A workload identity pool group.
1679 #
1680 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1681 # All identities in a workload identity pool with a certain attribute.
1682 #
1683 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
1684 # All identities in a workload identity pool.
1685 #
1686 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1687 # identifier) representing a user that has been recently deleted. For
1688 # example, `[email protected]?uid=123456789012345678901`. If the user is
1689 # recovered, this value reverts to `user:{emailid}` and the recovered user
1690 # retains the role in the binding.
1691 #
1692 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1693 # unique identifier) representing a service account that has been recently
1694 # deleted. For example,
1695 # `[email protected]?uid=123456789012345678901`.
1696 # If the service account is undeleted, this value reverts to
1697 # `serviceAccount:{emailid}` and the undeleted service account retains the
1698 # role in the binding.
1699 #
1700 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1701 # identifier) representing a Google group that has been recently
1702 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
1703 # the group is recovered, this value reverts to `group:{emailid}` and the
1704 # recovered group retains the role in the binding.
1705 #
1706 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1707 # Deleted single identity in a workforce identity pool. For example,
1708 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
1709 &quot;A String&quot;,
1710 ],
1711 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
1712 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1713 #
1714 # For an overview of the IAM roles and permissions, see the
1715 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
1716 # a list of the available pre-defined roles, see
1717 # [here](https://cloud.google.com/iam/docs/understanding-roles).
1718 },
1719 ],
1720 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
1721 # prevent simultaneous updates of a policy from overwriting each other.
1722 # It is strongly suggested that systems make use of the `etag` in the
1723 # read-modify-write cycle to perform policy updates in order to avoid race
1724 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1725 # systems are expected to put that etag in the request to `setIamPolicy` to
1726 # ensure that their change will be applied to the same version of the policy.
1727 #
1728 # **Important:** If you use IAM Conditions, you must include the `etag` field
1729 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1730 # you to overwrite a version `3` policy with a version `1` policy, and all of
1731 # the conditions in the version `3` policy are lost.
1732 &quot;version&quot;: 42, # Specifies the format of the policy.
1733 #
1734 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
1735 # are rejected.
1736 #
1737 # Any operation that affects conditional role bindings must specify version
1738 # `3`. This requirement applies to the following operations:
1739 #
1740 # * Getting a policy that includes a conditional role binding
1741 # * Adding a conditional role binding to a policy
1742 # * Changing a conditional role binding in a policy
1743 # * Removing any role binding, with or without a condition, from a policy
1744 # that includes conditions
1745 #
1746 # **Important:** If you use IAM Conditions, you must include the `etag` field
1747 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1748 # you to overwrite a version `3` policy with a version `1` policy, and all of
1749 # the conditions in the version `3` policy are lost.
1750 #
1751 # If a policy does not include any conditions, operations on that policy may
1752 # specify any valid version or leave the field unset.
1753 #
1754 # To learn which resources support conditions in their IAM policies, see the
1755 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1756 }</pre>
1757 </div>
1758
1759 <div class="method">
1760 <code class="details" id="insert">insert(project, region, body=None, requestId=None, validateOnly=None, x__xgafv=None)</code>
1761 <pre>Creates an InterconnectAttachment in the specified project using the data
1762 included in the request.
1763
1764 Args:
1765 project: string, Project ID for this request. (required)
1766 region: string, Name of the region for this request. (required)
1767 body: object, The request body.
1768 The object takes the form of:
1769
1770 { # Represents an Interconnect Attachment (VLAN) resource.
1771 #
1772 # You can use Interconnect attachments (VLANS) to connect your Virtual Private
1773 # Cloud networks to your on-premises networks through an Interconnect.
1774 # For more information, read
1775 # Creating VLAN Attachments.
1776 &quot;adminEnabled&quot;: True or False, # Determines whether this Attachment will carry packets.
1777 # Not present for PARTNER_PROVIDER.
1778 &quot;attachmentGroup&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the AttachmentGroup that includes this Attachment.
1779 &quot;bandwidth&quot;: &quot;A String&quot;, # Provisioned bandwidth capacity for the interconnect attachment. For
1780 # attachments of type DEDICATED, the user can set the bandwidth.
1781 # For attachments of type PARTNER, the Google Partner that is operating
1782 # the interconnect must set the bandwidth.
1783 # Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED,
1784 # and can take one of the following values:
1785 #
1786 # - BPS_50M: 50 Mbit/s
1787 # - BPS_100M: 100 Mbit/s
1788 # - BPS_200M: 200 Mbit/s
1789 # - BPS_300M: 300 Mbit/s
1790 # - BPS_400M: 400 Mbit/s
1791 # - BPS_500M: 500 Mbit/s
1792 # - BPS_1G: 1 Gbit/s
1793 # - BPS_2G: 2 Gbit/s
1794 # - BPS_5G: 5 Gbit/s
1795 # - BPS_10G: 10 Gbit/s
1796 # - BPS_20G: 20 Gbit/s
1797 # - BPS_50G: 50 Gbit/s
1798 # - BPS_100G: 100 Gbit/s
1799 # - BPS_400G: 400 Gbit/s
1800 &quot;candidateCloudRouterIpAddress&quot;: &quot;A String&quot;, # Single IPv4 address + prefix length to be configured on the cloud router
1801 # interface for this interconnect attachment.
1802 #
1803 # - Both candidate_cloud_router_ip_address and
1804 # candidate_customer_router_ip_address fields must be set or both must be
1805 # unset.
1806 # - Prefix length of both candidate_cloud_router_ip_address and
1807 # candidate_customer_router_ip_address must be the same.
1808 # - Max prefix length is 31.
1809 &quot;candidateCloudRouterIpv6Address&quot;: &quot;A String&quot;, # Single IPv6 address + prefix length to be configured on the cloud router
1810 # interface for this interconnect attachment.
1811 #
1812 # - Both candidate_cloud_router_ipv6_address and
1813 # candidate_customer_router_ipv6_address fields must be set or both must be
1814 # unset.
1815 # - Prefix length of both candidate_cloud_router_ipv6_address and
1816 # candidate_customer_router_ipv6_address must be the same.
1817 # - Max prefix length is 126.
1818 &quot;candidateCustomerRouterIpAddress&quot;: &quot;A String&quot;, # Single IPv4 address + prefix length to be configured on the customer router
1819 # interface for this interconnect attachment.
1820 &quot;candidateCustomerRouterIpv6Address&quot;: &quot;A String&quot;, # Single IPv6 address + prefix length to be configured on the customer router
1821 # interface for this interconnect attachment.
1822 &quot;candidateIpv6Subnets&quot;: [ # This field is not available.
1823 &quot;A String&quot;,
1824 ],
1825 &quot;candidateSubnets&quot;: [ # Input only. Up to 16 candidate prefixes that can be used to restrict the allocation
1826 # of cloudRouterIpAddress and customerRouterIpAddress for this attachment.
1827 # All prefixes must be within link-local address space (169.254.0.0/16) and
1828 # must be /29 or shorter (/28, /27, etc). Google will attempt to select an
1829 # unused /29 from the supplied candidate prefix(es). The request will fail if
1830 # all possible /29s are in use on Google&#x27;s edge. If not supplied, Google will
1831 # randomly select an unused /29 from all of link-local space.
1832 &quot;A String&quot;,
1833 ],
1834 &quot;cloudRouterIpAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IPv4 address + prefix length to be configured on Cloud Router
1835 # Interface for this interconnect attachment.
1836 &quot;cloudRouterIpv6Address&quot;: &quot;A String&quot;, # Output only. [Output Only] IPv6 address + prefix length to be configured on Cloud
1837 # Router Interface for this interconnect attachment.
1838 &quot;cloudRouterIpv6InterfaceId&quot;: &quot;A String&quot;, # This field is not available.
1839 &quot;configurationConstraints&quot;: { # Output only. [Output Only] Constraints for this attachment, if any. The attachment does
1840 # not work if these constraints are not met.
1841 &quot;bgpMd5&quot;: &quot;A String&quot;, # Output only. [Output Only] Whether the attachment&#x27;s BGP session
1842 # requires/allows/disallows BGP MD5 authentication. This can take one of
1843 # the following values: MD5_OPTIONAL, MD5_REQUIRED, MD5_UNSUPPORTED.
1844 #
1845 # For example, a Cross-Cloud Interconnect connection to a remote cloud
1846 # provider that requires BGP MD5 authentication has the
1847 # interconnectRemoteLocation attachment_configuration_constraints.bgp_md5
1848 # field set to MD5_REQUIRED, and that property is propagated to the
1849 # attachment. Similarly, if BGP MD5 is MD5_UNSUPPORTED, an error is
1850 # returned if MD5 is requested.
1851 &quot;bgpPeerAsnRanges&quot;: [ # Output only. [Output Only] List of ASN ranges that the remote location is known to
1852 # support. Formatted as an array of inclusive ranges {min: min-value, max:
1853 # max-value}. For example, [{min: 123, max: 123}, {min: 64512, max: 65534}]
1854 # allows the peer ASN to be 123 or anything in the range 64512-65534.
1855 #
1856 # This field is only advisory. Although the API accepts other ranges, these
1857 # are the ranges that we recommend.
1858 {
1859 &quot;max&quot;: 42,
1860 &quot;min&quot;: 42,
1861 },
1862 ],
1863 },
1864 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1865 # text format.
1866 &quot;customerRouterIpAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IPv4 address + prefix length to be configured on the customer
1867 # router subinterface for this interconnect attachment.
1868 &quot;customerRouterIpv6Address&quot;: &quot;A String&quot;, # Output only. [Output Only] IPv6 address + prefix length to be configured on the
1869 # customer router subinterface for this interconnect attachment.
1870 &quot;customerRouterIpv6InterfaceId&quot;: &quot;A String&quot;, # This field is not available.
1871 &quot;dataplaneVersion&quot;: 42, # Output only. [Output Only] Dataplane version for this InterconnectAttachment. This
1872 # field is only present for Dataplane version 2 and higher. Absence of this
1873 # field in the API output indicates that the Dataplane is version 1.
1874 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource.
1875 &quot;edgeAvailabilityDomain&quot;: &quot;A String&quot;, # Input only. Desired availability domain for the attachment. Only available for type
1876 # PARTNER, at creation time, and can take one of the following values:
1877 #
1878 # - AVAILABILITY_DOMAIN_ANY
1879 # - AVAILABILITY_DOMAIN_1
1880 # - AVAILABILITY_DOMAIN_2
1881 #
1882 #
1883 # For improved reliability, customers should configure a pair of attachments,
1884 # one per availability domain. The selected availability domain will be
1885 # provided to the Partner via the pairing key, so that the provisioned
1886 # circuit will lie in the specified domain. If not specified, the value will
1887 # default to AVAILABILITY_DOMAIN_ANY.
1888 &quot;encryption&quot;: &quot;A String&quot;, # Indicates the user-supplied encryption option of this VLAN attachment
1889 # (interconnectAttachment). Can only be specified at attachment creation
1890 # for PARTNER or DEDICATED attachments.
1891 # Possible values are:
1892 #
1893 # - NONE - This is the default value, which means that the
1894 # VLAN attachment carries unencrypted traffic. VMs are able to send
1895 # traffic to, or receive traffic from, such a VLAN attachment.
1896 # - IPSEC - The VLAN attachment carries only encrypted
1897 # traffic that is encrypted by an IPsec device, such as an HA VPN gateway or
1898 # third-party IPsec VPN. VMs cannot directly send traffic to, or receive
1899 # traffic from, such a VLAN attachment. To use *HA VPN over Cloud
1900 # Interconnect*, the VLAN attachment must be created with this
1901 # option.
1902 &quot;googleReferenceId&quot;: &quot;A String&quot;, # Output only. [Output Only] Google reference ID, to be used when raising support tickets
1903 # with Google or otherwise to debug backend connectivity issues.
1904 # [Deprecated] This field is not used.
1905 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1906 # defined by the server.
1907 &quot;interconnect&quot;: &quot;A String&quot;, # URL of the underlying Interconnect object that this attachment&#x27;s traffic
1908 # will traverse through.
1909 &quot;ipsecInternalAddresses&quot;: [ # A list of URLs of addresses that have been reserved for the VLAN
1910 # attachment. Used only for the VLAN attachment that has the encryption
1911 # option as IPSEC. The addresses must be regional internal IP address ranges.
1912 # When creating an HA VPN gateway over the VLAN attachment, if the attachment
1913 # is configured to use a regional internal IP address, then the VPN gateway&#x27;s
1914 # IP address is allocated from the IP address range specified here. For
1915 # example, if the HA VPN gateway&#x27;s interface 0 is paired to this VLAN
1916 # attachment, then a regional internal IP address for the VPN gateway
1917 # interface 0 will be allocated from the IP address specified for this
1918 # VLAN attachment.
1919 # If this field is not specified when creating the VLAN attachment, then
1920 # later on when creating an HA VPN gateway on this VLAN attachment, the HA
1921 # VPN gateway&#x27;s IP address is allocated from the regional external IP address
1922 # pool.
1923 &quot;A String&quot;,
1924 ],
1925 &quot;kind&quot;: &quot;compute#interconnectAttachment&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#interconnectAttachment for interconnect attachments.
1926 &quot;l2Forwarding&quot;: { # L2 Interconnect Attachment related configuration. # L2 Interconnect Attachment related config. This field is required if the
1927 # type is L2_DEDICATED.
1928 #
1929 # The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad)
1930 # within L2 packets are mapped to the destination appliances IP addresses.
1931 # The packet is then encapsulated with the appliance IP address and sent to
1932 # the edge appliance.
1933 &quot;applianceMappings&quot;: { # Optional. A map of VLAN tags to appliances and optional inner mapping
1934 # rules. If VLANs are not explicitly mapped to any appliance, the
1935 # defaultApplianceIpAddress is used.
1936 #
1937 # Each VLAN tag can be a single number or a range of numbers in the range
1938 # of 1 to 4094, e.g., &quot;1&quot; or &quot;4001-4094&quot;. Non-empty and non-overlapping
1939 # VLAN tag ranges are enforced, and violating operations will be rejected.
1940 #
1941 # The VLAN tags in the Ethernet header must use an ethertype value of
1942 # 0x88A8 or 0x8100.
1943 &quot;a_key&quot;: { # Two-level VLAN-to-Appliance mapping rule.
1944 &quot;applianceIpAddress&quot;: &quot;A String&quot;, # Optional. A single IPv4 or IPv6 address used as the destination IP
1945 # address for ingress packets that match on a VLAN tag, but do not match
1946 # a more specific inner VLAN tag.
1947 #
1948 # Unset field (null-value) indicates both VLAN tags are required to be
1949 # mapped. Otherwise, defaultApplianceIpAddress is used.
1950 &quot;innerVlanToApplianceMappings&quot;: [ # Optional. Used to match against the inner VLAN when the packet
1951 # contains two VLAN tags.
1952 #
1953 # A list of mapping rules from inner VLAN tags to IP addresses. If the
1954 # inner VLAN is not explicitly mapped to an IP address range, the
1955 # applianceIpAddress is used.
1956 { # The inner VLAN-to-Appliance mapping.
1957 &quot;innerApplianceIpAddress&quot;: &quot;A String&quot;, # Required in this object. A single IPv4 or IPv6 address used as the
1958 # destination IP address for ingress packets that match on both VLAN
1959 # tags.
1960 &quot;innerVlanTags&quot;: [ # Required in this object. Used to match the inner VLAN tag on the
1961 # packet. Each entry can be a single number or a range of numbers in
1962 # the range of 1 to 4094, e.g., [&quot;1&quot;, &quot;4001-4094&quot;] is valid. Non-empty
1963 # and Non-overlapping VLAN tag ranges are enforced, and violating
1964 # operations will be rejected.
1965 #
1966 # The inner VLAN tags must have an ethertype value of 0x8100.
1967 &quot;A String&quot;,
1968 ],
1969 },
1970 ],
1971 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of this appliance mapping rule.
1972 },
1973 },
1974 &quot;defaultApplianceIpAddress&quot;: &quot;A String&quot;, # Optional. A single IPv4 or IPv6 address used as the default destination
1975 # IP when there is no VLAN mapping result found.
1976 #
1977 # Unset field (null-value) indicates the unmatched packet should be
1978 # dropped.
1979 &quot;geneveHeader&quot;: { # GeneveHeader related configurations. # Optional. It represents the structure of a Geneve (Generic Network
1980 # Virtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various
1981 # protocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization
1982 # environments.
1983 &quot;vni&quot;: 42, # Optional. VNI is a 24-bit unique virtual network identifier, from 0 to
1984 # 16,777,215.
1985 },
1986 &quot;network&quot;: &quot;A String&quot;, # Required. Resource URL of the network to which this attachment belongs.
1987 &quot;tunnelEndpointIpAddress&quot;: &quot;A String&quot;, # Required. A single IPv4 or IPv6 address. This address will be used as the
1988 # source IP address for packets sent to the appliances, and must be used as
1989 # the destination IP address for packets that should be sent out through
1990 # this attachment.
1991 },
1992 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this InterconnectAttachment,
1993 # which is essentially a hash of the labels set used for optimistic locking.
1994 # The fingerprint is initially generated by Compute Engine and changes after
1995 # every request to modify or update labels. You must always provide an
1996 # up-to-date fingerprint hash in order to update or change labels,
1997 # otherwise the request will fail with error412 conditionNotMet.
1998 #
1999 # To see the latest fingerprint, make a get() request to
2000 # retrieve an InterconnectAttachment.
2001 &quot;labels&quot;: { # Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
2002 # Label values may be empty.
2003 &quot;a_key&quot;: &quot;A String&quot;,
2004 },
2005 &quot;mtu&quot;: 42, # Maximum Transmission Unit (MTU), in bytes, of packets passing through this
2006 # interconnect attachment.
2007 # Valid values are 1440, 1460, 1500, and 8896. If not specified,
2008 # the value will default to 1440.
2009 &quot;multicastEnabled&quot;: True or False, # Whether or not to permit multicast traffic for this attachment. Multicast
2010 # packets will be dropped if this is not enabled.
2011 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
2012 # The name must be 1-63 characters long, and comply withRFC1035.
2013 # Specifically, the name must be 1-63 characters long and match the regular
2014 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2015 # character must be a lowercase letter, and all following characters must
2016 # be a dash, lowercase letter, or digit, except the last character, which
2017 # cannot be a dash.
2018 &quot;operationalStatus&quot;: &quot;A String&quot;, # Output only. [Output Only] The current status of whether or not this interconnect
2019 # attachment is functional, which can take one of the following values:
2020 #
2021 # - OS_ACTIVE: The attachment has been turned up and is ready to
2022 # use.
2023 # - OS_UNPROVISIONED: The attachment is not ready to use yet,
2024 # because turnup is not complete.
2025 &quot;pairingKey&quot;: &quot;A String&quot;, # [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not
2026 # present for DEDICATED].
2027 # The opaque identifier of a PARTNER attachment used to initiate
2028 # provisioning with a selected partner.
2029 # Of the form &quot;XXXXX/region/domain&quot;
2030 &quot;params&quot;: { # Additional interconnect attachment parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
2031 # as part of resource payload.
2032 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
2033 # Tag keys and values have the same definition as resource
2034 # manager tags. The field is allowed for INSERT
2035 # only. The keys/values to set on the resource should be specified in
2036 # either ID { : } or Namespaced format
2037 # { : }.
2038 # For example the following are valid inputs:
2039 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
2040 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
2041 # Note:
2042 # * Invalid combinations of ID &amp; namespaced format is not supported. For
2043 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
2044 # * Inconsistent format is not supported. For instance:
2045 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
2046 &quot;a_key&quot;: &quot;A String&quot;,
2047 },
2048 },
2049 &quot;partnerAsn&quot;: &quot;A String&quot;, # Optional BGP ASN for the router supplied by a Layer 3 Partner if they
2050 # configured BGP on behalf of the customer.
2051 # Output only for PARTNER type, input only for PARTNER_PROVIDER, not
2052 # available for DEDICATED.
2053 &quot;partnerMetadata&quot;: { # Informational metadata about Partner attachments from Partners to display # Informational metadata about Partner attachments from Partners to display
2054 # to customers.
2055 # Output only for PARTNER type, mutable for PARTNER_PROVIDER, not
2056 # available for DEDICATED.
2057 # to customers. These fields are propagated from PARTNER_PROVIDER
2058 # attachments to their corresponding PARTNER attachments.
2059 &quot;interconnectName&quot;: &quot;A String&quot;, # Plain text name of the Interconnect this attachment is connected to, as
2060 # displayed in the Partner&#x27;s portal. For instance &quot;Chicago 1&quot;.
2061 # This value may be validated to match approved Partner values.
2062 &quot;partnerName&quot;: &quot;A String&quot;, # Plain text name of the Partner providing this attachment.
2063 # This value may be validated to match approved Partner values.
2064 &quot;portalUrl&quot;: &quot;A String&quot;, # URL of the Partner&#x27;s portal for this Attachment. Partners may customise
2065 # this to be a deep link to the specific resource on the Partner portal.
2066 # This value may be validated to match approved Partner values.
2067 },
2068 &quot;privateInterconnectInfo&quot;: { # Information for an interconnect attachment when this belongs to an # Output only. [Output Only] Information specific to an InterconnectAttachment.
2069 # This property is populated if the interconnect that
2070 # this is attached to is of type DEDICATED.
2071 # interconnect of type DEDICATED.
2072 &quot;tag8021q&quot;: 42, # [Output Only] 802.1q encapsulation tag to be used for traffic between
2073 # Google and the customer, going to and from this network and region.
2074 },
2075 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional interconnect attachment
2076 # resides.
2077 # You must specify this field as part of the HTTP request URL. It is
2078 # not settable as a field in the request body.
2079 &quot;remoteService&quot;: &quot;A String&quot;, # Output only. [Output Only]
2080 # If the attachment is on a Cross-Cloud Interconnect connection, this field
2081 # contains the interconnect&#x27;s remote location service provider. Example
2082 # values: &quot;Amazon Web Services&quot; &quot;Microsoft Azure&quot;.
2083 #
2084 # The field is set only for attachments on Cross-Cloud Interconnect
2085 # connections. Its value is copied from the InterconnectRemoteLocation
2086 # remoteService field.
2087 &quot;router&quot;: &quot;A String&quot;, # URL of the Cloud Router to be used for dynamic routing. This router must be
2088 # in the same region as this InterconnectAttachment. The
2089 # InterconnectAttachment will automatically connect the Interconnect to the
2090 # network &amp; region within which the Cloud Router is configured.
2091 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
2092 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
2093 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2094 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this interconnect attachment to identify whether the
2095 # IPv6 feature is enabled or not. If not specified, IPV4_ONLY
2096 # will be used.
2097 #
2098 # This field can be both set at interconnect attachments creation and
2099 # update interconnect attachment operations.
2100 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The current state of this attachment&#x27;s functionality.
2101 # Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE,
2102 # PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values
2103 # PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used
2104 # for only PARTNER and PARTNER_PROVIDER interconnect attachments.
2105 # This state can take one of the following values:
2106 #
2107 # - ACTIVE: The attachment has been turned up and is ready to use.
2108 # - UNPROVISIONED: The attachment is not ready to use yet, because turnup
2109 # is not complete.
2110 # - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet
2111 # been configured on the Partner side.
2112 # - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of
2113 # provisioning after a PARTNER_PROVIDER attachment was created that
2114 # references it.
2115 # - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER
2116 # attachment that is waiting for a customer to activate it.
2117 # - DEFUNCT:
2118 # The attachment was deleted externally and is no longer functional. This
2119 # could be because the associated Interconnect was removed, or because the
2120 # other side of a Partner attachment was deleted.
2121 &quot;subnetLength&quot;: 42, # Input only. Length of the IPv4 subnet mask.
2122 # Allowed values:
2123 #
2124 #
2125 # - 29 (default)
2126 # - 30
2127 #
2128 # The default value is 29, except for Cross-Cloud Interconnect
2129 # connections that use an InterconnectRemoteLocation with a
2130 # constraints.subnetLengthRange.min equal to 30. For example,
2131 # connections that use an Azure remote location fall into this
2132 # category. In these cases, the default value is 30, and requesting
2133 # 29 returns an error.
2134 #
2135 # Where both 29 and 30 are allowed, 29 is preferred, because it gives
2136 # Google Cloud Support more debugging visibility.
2137 &quot;type&quot;: &quot;A String&quot;, # The type of interconnect attachment this is, which can take one of the
2138 # following values:
2139 #
2140 # - DEDICATED: an attachment to a Dedicated Interconnect.
2141 # - PARTNER: an attachment to a Partner Interconnect, created by the
2142 # customer.
2143 # - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by
2144 # the partner.
2145 #
2146 # - L2_DEDICATED: a L2 attachment to a Dedicated Interconnect.
2147 &quot;vlanTag8021q&quot;: 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093.
2148 # Only specified at creation time.
2149 }
2150
2151 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2152 that if you must retry your request, the server will know to ignore the
2153 request if it has already been completed.
2154
2155 For example, consider a situation where you make an initial request and
2156 the request times out. If you make the request again with the same
2157 request ID, the server can check if original operation with the same
2158 request ID was received, and if so, will ignore the second request. This
2159 prevents clients from accidentally creating duplicate commitments.
2160
2161 The request ID must be
2162 a valid UUID with the exception that zero UUID is not supported
2163 (00000000-0000-0000-0000-000000000000).
2164 validateOnly: boolean, If true, the request will not be committed.
2165 x__xgafv: string, V1 error format.
2166 Allowed values
2167 1 - v1 error format
2168 2 - v2 error format
2169
2170 Returns:
2171 An object of the form:
2172
2173 { # Represents an Operation resource.
2174 #
2175 # Google Compute Engine has three Operation resources:
2176 #
2177 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
2178 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
2179 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
2180 #
2181 # You can use an operation resource to manage asynchronous API requests.
2182 # For more information, readHandling
2183 # API responses.
2184 #
2185 # Operations can be global, regional or zonal.
2186 #
2187 # - For global operations, use the `globalOperations`
2188 # resource.
2189 # - For regional operations, use the
2190 # `regionOperations` resource.
2191 # - For zonal operations, use
2192 # the `zoneOperations` resource.
2193 #
2194 #
2195 #
2196 # For more information, read
2197 # Global, Regional, and Zonal Resources.
2198 #
2199 # Note that completed Operation resources have a limited
2200 # retention period.
2201 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2202 # Not present otherwise.
2203 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2204 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2205 # set when the operation is created.
2206 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2207 # text format.
2208 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2209 # this field will be populated.
2210 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2211 # operation.
2212 {
2213 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2214 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2215 # details. There is a set of defined message types to use for providing
2216 # details.The syntax depends on the error code. For example,
2217 # QuotaExceededInfo will have details when the error code is
2218 # QUOTA_EXCEEDED.
2219 {
2220 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2221 #
2222 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2223 # is not enabled:
2224 #
2225 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2226 # &quot;domain&quot;: &quot;googleapis.com&quot;
2227 # &quot;metadata&quot;: {
2228 # &quot;resource&quot;: &quot;projects/123&quot;,
2229 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2230 # }
2231 # }
2232 #
2233 # This response indicates that the pubsub.googleapis.com API is not enabled.
2234 #
2235 # Example of an error that is returned when attempting to create a Spanner
2236 # instance in a region that is out of stock:
2237 #
2238 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2239 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2240 # &quot;metadata&quot;: {
2241 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2242 # }
2243 # }
2244 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2245 # is typically the registered service name of the tool or product that
2246 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2247 # generated by some common infrastructure, the error domain must be a
2248 # globally unique value that identifies the infrastructure. For Google API
2249 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2250 &quot;metadatas&quot;: { # Additional structured details about this error.
2251 #
2252 # Keys must match a regular expression of `a-z+` but should
2253 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2254 # length. When identifying the current value of an exceeded limit, the units
2255 # should be contained in the key, not the value. For example, rather than
2256 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2257 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2258 # instances that can be created in a single (batch) request.
2259 &quot;a_key&quot;: &quot;A String&quot;,
2260 },
2261 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2262 # proximate cause of the error. Error reasons are unique within a particular
2263 # domain of errors. This should be at most 63 characters and match a
2264 # regular expression of `A-Z+[A-Z0-9]`, which represents
2265 # UPPER_SNAKE_CASE.
2266 },
2267 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2268 #
2269 # For example, if a quota check failed with an error indicating the calling
2270 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2271 # directly to the right place in the developer console to flip the bit.
2272 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2273 { # Describes a URL link.
2274 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2275 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2276 },
2277 ],
2278 },
2279 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2280 # which can be attached to an RPC error.
2281 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2282 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2283 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2284 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2285 },
2286 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2287 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2288 &quot;a_key&quot;: &quot;A String&quot;,
2289 },
2290 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2291 # type or metric.
2292 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2293 # or metric.
2294 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2295 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2296 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2297 },
2298 },
2299 ],
2300 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2301 # This property is optional.
2302 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2303 },
2304 ],
2305 },
2306 &quot;getVersionOperationMetadata&quot;: {
2307 &quot;inlineSbomInfo&quot;: {
2308 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2309 # appropriate identifiers.
2310 &quot;a_key&quot;: &quot;A String&quot;,
2311 },
2312 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2313 # identifiers.
2314 &quot;a_key&quot;: &quot;A String&quot;,
2315 },
2316 },
2317 },
2318 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2319 # message that was returned, such as `NOT FOUND`.
2320 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2321 # status code that was returned. For example, a `404` means the
2322 # resource was not found.
2323 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2324 # defined by the server.
2325 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2326 # This value is inRFC3339
2327 # text format.
2328 &quot;instancesBulkInsertOperationMetadata&quot;: {
2329 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2330 # Example key: zones/us-central1-a
2331 &quot;a_key&quot;: {
2332 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2333 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2334 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2335 # error.
2336 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2337 # if the flow is rolling forward or rolling back.
2338 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2339 },
2340 },
2341 },
2342 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2343 # Operation resources.
2344 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2345 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2346 # group of operations results from a `bulkInsert` API request.
2347 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2348 # `update`, or `delete`, and so on.
2349 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2350 # There is no requirement that this be linear or support any granularity of
2351 # operations. This should not be used to guess when the operation will be
2352 # complete. This number should monotonically increase as the operation
2353 # progresses.
2354 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2355 # applicable when performing regional operations.
2356 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2357 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2358 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2359 # this field will contain information on all underlying zonal actions and
2360 # their state.
2361 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2362 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2363 # Example key: zones/us-central1-a
2364 &quot;a_key&quot;: {
2365 &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
2366 # populated.
2367 # different programming environments, including REST APIs and RPC APIs. It is
2368 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2369 # three pieces of data: error code, error message, and error details.
2370 #
2371 # You can find out more about this error model and how to work with it in the
2372 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2373 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2374 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2375 # message types for APIs to use.
2376 {
2377 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2378 },
2379 ],
2380 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2381 # user-facing error message should be localized and sent in the
2382 # google.rpc.Status.details field, or localized by the client.
2383 },
2384 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2385 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2386 },
2387 },
2388 },
2389 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2390 # This value is inRFC3339
2391 # text format.
2392 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2393 # following:
2394 # `PENDING`, `RUNNING`, or `DONE`.
2395 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2396 # operation.
2397 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2398 # of the target resource.
2399 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2400 # operations related to creating a snapshot, this points to the disk
2401 # that the snapshot was created from.
2402 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2403 # `[email protected]` or
2404 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2405 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2406 # operation, this field will be populated.
2407 {
2408 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2409 # Engine returns NO_RESULTS_ON_PAGE if there
2410 # are no results in the response.
2411 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2412 # value format. For example:
2413 #
2414 # &quot;data&quot;: [
2415 # {
2416 # &quot;key&quot;: &quot;scope&quot;,
2417 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2418 # }
2419 {
2420 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2421 # returned. For example, for warnings where there are no results in a list
2422 # request for a particular zone, this key might be scope and
2423 # the key value might be the zone name. Other examples might be a key
2424 # indicating a deprecated resource and a suggested replacement, or a
2425 # warning about invalid network settings (for example, if an instance
2426 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2427 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2428 },
2429 ],
2430 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2431 },
2432 ],
2433 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2434 # applicable when performing per-zone operations.
2435 }</pre>
2436 </div>
2437
2438 <div class="method">
2439 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
2440 <pre>Retrieves the list of interconnect attachments contained within
2441 the specified region.
2442
2443 Args:
2444 project: string, Project ID for this request. (required)
2445 region: string, Name of the region for this request. (required)
2446 filter: string, A filter expression that filters resources listed in the response. Most
2447 Compute resources support two types of filter expressions:
2448 expressions that support regular expressions and expressions that follow
2449 API improvement proposal AIP-160.
2450 These two types of filter expressions cannot be mixed in one request.
2451
2452 If you want to use AIP-160, your expression must specify the field name, an
2453 operator, and the value that you want to use for filtering. The value
2454 must be a string, a number, or a boolean. The operator
2455 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
2456
2457 For example, if you are filtering Compute Engine instances, you can
2458 exclude instances named `example-instance` by specifying
2459 `name != example-instance`.
2460
2461 The `:*` comparison can be used to test whether a key has been defined.
2462 For example, to find all objects with `owner` label use:
2463 ```
2464 labels.owner:*
2465 ```
2466
2467 You can also filter nested fields. For example, you could specify
2468 `scheduling.automaticRestart = false` to include instances only
2469 if they are not scheduled for automatic restarts. You can use filtering
2470 on nested fields to filter based onresource labels.
2471
2472 To filter on multiple expressions, provide each separate expression within
2473 parentheses. For example:
2474 ```
2475 (scheduling.automaticRestart = true)
2476 (cpuPlatform = &quot;Intel Skylake&quot;)
2477 ```
2478 By default, each expression is an `AND` expression. However, you
2479 can include `AND` and `OR` expressions explicitly.
2480 For example:
2481 ```
2482 (cpuPlatform = &quot;Intel Skylake&quot;) OR
2483 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
2484 (scheduling.automaticRestart = true)
2485 ```
2486
2487 If you want to use a regular expression, use the `eq` (equal) or `ne`
2488 (not equal) operator against a single un-parenthesized expression with or
2489 without quotes or against multiple parenthesized expressions. Examples:
2490
2491 `fieldname eq unquoted literal`
2492 `fieldname eq &#x27;single quoted literal&#x27;`
2493 `fieldname eq &quot;double quoted literal&quot;`
2494 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
2495
2496 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
2497 The literal value must match the entire field.
2498
2499 For example, to filter for instances that do not end with name &quot;instance&quot;,
2500 you would use `name ne .*instance`.
2501
2502 You cannot combine constraints on multiple fields using regular
2503 expressions.
2504 maxResults: integer, The maximum number of results per page that should be returned.
2505 If the number of available results is larger than `maxResults`,
2506 Compute Engine returns a `nextPageToken` that can be used to get
2507 the next page of results in subsequent list requests. Acceptable values are
2508 `0` to `500`, inclusive. (Default: `500`)
2509 orderBy: string, Sorts list results by a certain order. By default, results
2510 are returned in alphanumerical order based on the resource name.
2511
2512 You can also sort results in descending order based on the creation
2513 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
2514 results based on the `creationTimestamp` field in
2515 reverse chronological order (newest result first). Use this to sort
2516 resources like operations so that the newest operation is returned first.
2517
2518 Currently, only sorting by `name` or
2519 `creationTimestamp desc` is supported.
2520 pageToken: string, Specifies a page token to use. Set `pageToken` to the
2521 `nextPageToken` returned by a previous list request to get
2522 the next page of results.
2523 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
2524 of failure. The default value is false.
2525
2526 For example, when partial success behavior is enabled, aggregatedList for a
2527 single zone scope either returns all resources in the zone or no resources,
2528 with an error code.
2529 x__xgafv: string, V1 error format.
2530 Allowed values
2531 1 - v1 error format
2532 2 - v2 error format
2533
2534 Returns:
2535 An object of the form:
2536
2537 { # Response to the list request, and contains a list of interconnect
2538 # attachments.
2539 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
2540 &quot;items&quot;: [ # A list of InterconnectAttachment resources.
2541 { # Represents an Interconnect Attachment (VLAN) resource.
2542 #
2543 # You can use Interconnect attachments (VLANS) to connect your Virtual Private
2544 # Cloud networks to your on-premises networks through an Interconnect.
2545 # For more information, read
2546 # Creating VLAN Attachments.
2547 &quot;adminEnabled&quot;: True or False, # Determines whether this Attachment will carry packets.
2548 # Not present for PARTNER_PROVIDER.
2549 &quot;attachmentGroup&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the AttachmentGroup that includes this Attachment.
2550 &quot;bandwidth&quot;: &quot;A String&quot;, # Provisioned bandwidth capacity for the interconnect attachment. For
2551 # attachments of type DEDICATED, the user can set the bandwidth.
2552 # For attachments of type PARTNER, the Google Partner that is operating
2553 # the interconnect must set the bandwidth.
2554 # Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED,
2555 # and can take one of the following values:
2556 #
2557 # - BPS_50M: 50 Mbit/s
2558 # - BPS_100M: 100 Mbit/s
2559 # - BPS_200M: 200 Mbit/s
2560 # - BPS_300M: 300 Mbit/s
2561 # - BPS_400M: 400 Mbit/s
2562 # - BPS_500M: 500 Mbit/s
2563 # - BPS_1G: 1 Gbit/s
2564 # - BPS_2G: 2 Gbit/s
2565 # - BPS_5G: 5 Gbit/s
2566 # - BPS_10G: 10 Gbit/s
2567 # - BPS_20G: 20 Gbit/s
2568 # - BPS_50G: 50 Gbit/s
2569 # - BPS_100G: 100 Gbit/s
2570 # - BPS_400G: 400 Gbit/s
2571 &quot;candidateCloudRouterIpAddress&quot;: &quot;A String&quot;, # Single IPv4 address + prefix length to be configured on the cloud router
2572 # interface for this interconnect attachment.
2573 #
2574 # - Both candidate_cloud_router_ip_address and
2575 # candidate_customer_router_ip_address fields must be set or both must be
2576 # unset.
2577 # - Prefix length of both candidate_cloud_router_ip_address and
2578 # candidate_customer_router_ip_address must be the same.
2579 # - Max prefix length is 31.
2580 &quot;candidateCloudRouterIpv6Address&quot;: &quot;A String&quot;, # Single IPv6 address + prefix length to be configured on the cloud router
2581 # interface for this interconnect attachment.
2582 #
2583 # - Both candidate_cloud_router_ipv6_address and
2584 # candidate_customer_router_ipv6_address fields must be set or both must be
2585 # unset.
2586 # - Prefix length of both candidate_cloud_router_ipv6_address and
2587 # candidate_customer_router_ipv6_address must be the same.
2588 # - Max prefix length is 126.
2589 &quot;candidateCustomerRouterIpAddress&quot;: &quot;A String&quot;, # Single IPv4 address + prefix length to be configured on the customer router
2590 # interface for this interconnect attachment.
2591 &quot;candidateCustomerRouterIpv6Address&quot;: &quot;A String&quot;, # Single IPv6 address + prefix length to be configured on the customer router
2592 # interface for this interconnect attachment.
2593 &quot;candidateIpv6Subnets&quot;: [ # This field is not available.
2594 &quot;A String&quot;,
2595 ],
2596 &quot;candidateSubnets&quot;: [ # Input only. Up to 16 candidate prefixes that can be used to restrict the allocation
2597 # of cloudRouterIpAddress and customerRouterIpAddress for this attachment.
2598 # All prefixes must be within link-local address space (169.254.0.0/16) and
2599 # must be /29 or shorter (/28, /27, etc). Google will attempt to select an
2600 # unused /29 from the supplied candidate prefix(es). The request will fail if
2601 # all possible /29s are in use on Google&#x27;s edge. If not supplied, Google will
2602 # randomly select an unused /29 from all of link-local space.
2603 &quot;A String&quot;,
2604 ],
2605 &quot;cloudRouterIpAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IPv4 address + prefix length to be configured on Cloud Router
2606 # Interface for this interconnect attachment.
2607 &quot;cloudRouterIpv6Address&quot;: &quot;A String&quot;, # Output only. [Output Only] IPv6 address + prefix length to be configured on Cloud
2608 # Router Interface for this interconnect attachment.
2609 &quot;cloudRouterIpv6InterfaceId&quot;: &quot;A String&quot;, # This field is not available.
2610 &quot;configurationConstraints&quot;: { # Output only. [Output Only] Constraints for this attachment, if any. The attachment does
2611 # not work if these constraints are not met.
2612 &quot;bgpMd5&quot;: &quot;A String&quot;, # Output only. [Output Only] Whether the attachment&#x27;s BGP session
2613 # requires/allows/disallows BGP MD5 authentication. This can take one of
2614 # the following values: MD5_OPTIONAL, MD5_REQUIRED, MD5_UNSUPPORTED.
2615 #
2616 # For example, a Cross-Cloud Interconnect connection to a remote cloud
2617 # provider that requires BGP MD5 authentication has the
2618 # interconnectRemoteLocation attachment_configuration_constraints.bgp_md5
2619 # field set to MD5_REQUIRED, and that property is propagated to the
2620 # attachment. Similarly, if BGP MD5 is MD5_UNSUPPORTED, an error is
2621 # returned if MD5 is requested.
2622 &quot;bgpPeerAsnRanges&quot;: [ # Output only. [Output Only] List of ASN ranges that the remote location is known to
2623 # support. Formatted as an array of inclusive ranges {min: min-value, max:
2624 # max-value}. For example, [{min: 123, max: 123}, {min: 64512, max: 65534}]
2625 # allows the peer ASN to be 123 or anything in the range 64512-65534.
2626 #
2627 # This field is only advisory. Although the API accepts other ranges, these
2628 # are the ranges that we recommend.
2629 {
2630 &quot;max&quot;: 42,
2631 &quot;min&quot;: 42,
2632 },
2633 ],
2634 },
2635 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2636 # text format.
2637 &quot;customerRouterIpAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IPv4 address + prefix length to be configured on the customer
2638 # router subinterface for this interconnect attachment.
2639 &quot;customerRouterIpv6Address&quot;: &quot;A String&quot;, # Output only. [Output Only] IPv6 address + prefix length to be configured on the
2640 # customer router subinterface for this interconnect attachment.
2641 &quot;customerRouterIpv6InterfaceId&quot;: &quot;A String&quot;, # This field is not available.
2642 &quot;dataplaneVersion&quot;: 42, # Output only. [Output Only] Dataplane version for this InterconnectAttachment. This
2643 # field is only present for Dataplane version 2 and higher. Absence of this
2644 # field in the API output indicates that the Dataplane is version 1.
2645 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource.
2646 &quot;edgeAvailabilityDomain&quot;: &quot;A String&quot;, # Input only. Desired availability domain for the attachment. Only available for type
2647 # PARTNER, at creation time, and can take one of the following values:
2648 #
2649 # - AVAILABILITY_DOMAIN_ANY
2650 # - AVAILABILITY_DOMAIN_1
2651 # - AVAILABILITY_DOMAIN_2
2652 #
2653 #
2654 # For improved reliability, customers should configure a pair of attachments,
2655 # one per availability domain. The selected availability domain will be
2656 # provided to the Partner via the pairing key, so that the provisioned
2657 # circuit will lie in the specified domain. If not specified, the value will
2658 # default to AVAILABILITY_DOMAIN_ANY.
2659 &quot;encryption&quot;: &quot;A String&quot;, # Indicates the user-supplied encryption option of this VLAN attachment
2660 # (interconnectAttachment). Can only be specified at attachment creation
2661 # for PARTNER or DEDICATED attachments.
2662 # Possible values are:
2663 #
2664 # - NONE - This is the default value, which means that the
2665 # VLAN attachment carries unencrypted traffic. VMs are able to send
2666 # traffic to, or receive traffic from, such a VLAN attachment.
2667 # - IPSEC - The VLAN attachment carries only encrypted
2668 # traffic that is encrypted by an IPsec device, such as an HA VPN gateway or
2669 # third-party IPsec VPN. VMs cannot directly send traffic to, or receive
2670 # traffic from, such a VLAN attachment. To use *HA VPN over Cloud
2671 # Interconnect*, the VLAN attachment must be created with this
2672 # option.
2673 &quot;googleReferenceId&quot;: &quot;A String&quot;, # Output only. [Output Only] Google reference ID, to be used when raising support tickets
2674 # with Google or otherwise to debug backend connectivity issues.
2675 # [Deprecated] This field is not used.
2676 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
2677 # defined by the server.
2678 &quot;interconnect&quot;: &quot;A String&quot;, # URL of the underlying Interconnect object that this attachment&#x27;s traffic
2679 # will traverse through.
2680 &quot;ipsecInternalAddresses&quot;: [ # A list of URLs of addresses that have been reserved for the VLAN
2681 # attachment. Used only for the VLAN attachment that has the encryption
2682 # option as IPSEC. The addresses must be regional internal IP address ranges.
2683 # When creating an HA VPN gateway over the VLAN attachment, if the attachment
2684 # is configured to use a regional internal IP address, then the VPN gateway&#x27;s
2685 # IP address is allocated from the IP address range specified here. For
2686 # example, if the HA VPN gateway&#x27;s interface 0 is paired to this VLAN
2687 # attachment, then a regional internal IP address for the VPN gateway
2688 # interface 0 will be allocated from the IP address specified for this
2689 # VLAN attachment.
2690 # If this field is not specified when creating the VLAN attachment, then
2691 # later on when creating an HA VPN gateway on this VLAN attachment, the HA
2692 # VPN gateway&#x27;s IP address is allocated from the regional external IP address
2693 # pool.
2694 &quot;A String&quot;,
2695 ],
2696 &quot;kind&quot;: &quot;compute#interconnectAttachment&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#interconnectAttachment for interconnect attachments.
2697 &quot;l2Forwarding&quot;: { # L2 Interconnect Attachment related configuration. # L2 Interconnect Attachment related config. This field is required if the
2698 # type is L2_DEDICATED.
2699 #
2700 # The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad)
2701 # within L2 packets are mapped to the destination appliances IP addresses.
2702 # The packet is then encapsulated with the appliance IP address and sent to
2703 # the edge appliance.
2704 &quot;applianceMappings&quot;: { # Optional. A map of VLAN tags to appliances and optional inner mapping
2705 # rules. If VLANs are not explicitly mapped to any appliance, the
2706 # defaultApplianceIpAddress is used.
2707 #
2708 # Each VLAN tag can be a single number or a range of numbers in the range
2709 # of 1 to 4094, e.g., &quot;1&quot; or &quot;4001-4094&quot;. Non-empty and non-overlapping
2710 # VLAN tag ranges are enforced, and violating operations will be rejected.
2711 #
2712 # The VLAN tags in the Ethernet header must use an ethertype value of
2713 # 0x88A8 or 0x8100.
2714 &quot;a_key&quot;: { # Two-level VLAN-to-Appliance mapping rule.
2715 &quot;applianceIpAddress&quot;: &quot;A String&quot;, # Optional. A single IPv4 or IPv6 address used as the destination IP
2716 # address for ingress packets that match on a VLAN tag, but do not match
2717 # a more specific inner VLAN tag.
2718 #
2719 # Unset field (null-value) indicates both VLAN tags are required to be
2720 # mapped. Otherwise, defaultApplianceIpAddress is used.
2721 &quot;innerVlanToApplianceMappings&quot;: [ # Optional. Used to match against the inner VLAN when the packet
2722 # contains two VLAN tags.
2723 #
2724 # A list of mapping rules from inner VLAN tags to IP addresses. If the
2725 # inner VLAN is not explicitly mapped to an IP address range, the
2726 # applianceIpAddress is used.
2727 { # The inner VLAN-to-Appliance mapping.
2728 &quot;innerApplianceIpAddress&quot;: &quot;A String&quot;, # Required in this object. A single IPv4 or IPv6 address used as the
2729 # destination IP address for ingress packets that match on both VLAN
2730 # tags.
2731 &quot;innerVlanTags&quot;: [ # Required in this object. Used to match the inner VLAN tag on the
2732 # packet. Each entry can be a single number or a range of numbers in
2733 # the range of 1 to 4094, e.g., [&quot;1&quot;, &quot;4001-4094&quot;] is valid. Non-empty
2734 # and Non-overlapping VLAN tag ranges are enforced, and violating
2735 # operations will be rejected.
2736 #
2737 # The inner VLAN tags must have an ethertype value of 0x8100.
2738 &quot;A String&quot;,
2739 ],
2740 },
2741 ],
2742 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of this appliance mapping rule.
2743 },
2744 },
2745 &quot;defaultApplianceIpAddress&quot;: &quot;A String&quot;, # Optional. A single IPv4 or IPv6 address used as the default destination
2746 # IP when there is no VLAN mapping result found.
2747 #
2748 # Unset field (null-value) indicates the unmatched packet should be
2749 # dropped.
2750 &quot;geneveHeader&quot;: { # GeneveHeader related configurations. # Optional. It represents the structure of a Geneve (Generic Network
2751 # Virtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various
2752 # protocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization
2753 # environments.
2754 &quot;vni&quot;: 42, # Optional. VNI is a 24-bit unique virtual network identifier, from 0 to
2755 # 16,777,215.
2756 },
2757 &quot;network&quot;: &quot;A String&quot;, # Required. Resource URL of the network to which this attachment belongs.
2758 &quot;tunnelEndpointIpAddress&quot;: &quot;A String&quot;, # Required. A single IPv4 or IPv6 address. This address will be used as the
2759 # source IP address for packets sent to the appliances, and must be used as
2760 # the destination IP address for packets that should be sent out through
2761 # this attachment.
2762 },
2763 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this InterconnectAttachment,
2764 # which is essentially a hash of the labels set used for optimistic locking.
2765 # The fingerprint is initially generated by Compute Engine and changes after
2766 # every request to modify or update labels. You must always provide an
2767 # up-to-date fingerprint hash in order to update or change labels,
2768 # otherwise the request will fail with error412 conditionNotMet.
2769 #
2770 # To see the latest fingerprint, make a get() request to
2771 # retrieve an InterconnectAttachment.
2772 &quot;labels&quot;: { # Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
2773 # Label values may be empty.
2774 &quot;a_key&quot;: &quot;A String&quot;,
2775 },
2776 &quot;mtu&quot;: 42, # Maximum Transmission Unit (MTU), in bytes, of packets passing through this
2777 # interconnect attachment.
2778 # Valid values are 1440, 1460, 1500, and 8896. If not specified,
2779 # the value will default to 1440.
2780 &quot;multicastEnabled&quot;: True or False, # Whether or not to permit multicast traffic for this attachment. Multicast
2781 # packets will be dropped if this is not enabled.
2782 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
2783 # The name must be 1-63 characters long, and comply withRFC1035.
2784 # Specifically, the name must be 1-63 characters long and match the regular
2785 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2786 # character must be a lowercase letter, and all following characters must
2787 # be a dash, lowercase letter, or digit, except the last character, which
2788 # cannot be a dash.
2789 &quot;operationalStatus&quot;: &quot;A String&quot;, # Output only. [Output Only] The current status of whether or not this interconnect
2790 # attachment is functional, which can take one of the following values:
2791 #
2792 # - OS_ACTIVE: The attachment has been turned up and is ready to
2793 # use.
2794 # - OS_UNPROVISIONED: The attachment is not ready to use yet,
2795 # because turnup is not complete.
2796 &quot;pairingKey&quot;: &quot;A String&quot;, # [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not
2797 # present for DEDICATED].
2798 # The opaque identifier of a PARTNER attachment used to initiate
2799 # provisioning with a selected partner.
2800 # Of the form &quot;XXXXX/region/domain&quot;
2801 &quot;params&quot;: { # Additional interconnect attachment parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
2802 # as part of resource payload.
2803 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
2804 # Tag keys and values have the same definition as resource
2805 # manager tags. The field is allowed for INSERT
2806 # only. The keys/values to set on the resource should be specified in
2807 # either ID { : } or Namespaced format
2808 # { : }.
2809 # For example the following are valid inputs:
2810 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
2811 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
2812 # Note:
2813 # * Invalid combinations of ID &amp; namespaced format is not supported. For
2814 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
2815 # * Inconsistent format is not supported. For instance:
2816 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
2817 &quot;a_key&quot;: &quot;A String&quot;,
2818 },
2819 },
2820 &quot;partnerAsn&quot;: &quot;A String&quot;, # Optional BGP ASN for the router supplied by a Layer 3 Partner if they
2821 # configured BGP on behalf of the customer.
2822 # Output only for PARTNER type, input only for PARTNER_PROVIDER, not
2823 # available for DEDICATED.
2824 &quot;partnerMetadata&quot;: { # Informational metadata about Partner attachments from Partners to display # Informational metadata about Partner attachments from Partners to display
2825 # to customers.
2826 # Output only for PARTNER type, mutable for PARTNER_PROVIDER, not
2827 # available for DEDICATED.
2828 # to customers. These fields are propagated from PARTNER_PROVIDER
2829 # attachments to their corresponding PARTNER attachments.
2830 &quot;interconnectName&quot;: &quot;A String&quot;, # Plain text name of the Interconnect this attachment is connected to, as
2831 # displayed in the Partner&#x27;s portal. For instance &quot;Chicago 1&quot;.
2832 # This value may be validated to match approved Partner values.
2833 &quot;partnerName&quot;: &quot;A String&quot;, # Plain text name of the Partner providing this attachment.
2834 # This value may be validated to match approved Partner values.
2835 &quot;portalUrl&quot;: &quot;A String&quot;, # URL of the Partner&#x27;s portal for this Attachment. Partners may customise
2836 # this to be a deep link to the specific resource on the Partner portal.
2837 # This value may be validated to match approved Partner values.
2838 },
2839 &quot;privateInterconnectInfo&quot;: { # Information for an interconnect attachment when this belongs to an # Output only. [Output Only] Information specific to an InterconnectAttachment.
2840 # This property is populated if the interconnect that
2841 # this is attached to is of type DEDICATED.
2842 # interconnect of type DEDICATED.
2843 &quot;tag8021q&quot;: 42, # [Output Only] 802.1q encapsulation tag to be used for traffic between
2844 # Google and the customer, going to and from this network and region.
2845 },
2846 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional interconnect attachment
2847 # resides.
2848 # You must specify this field as part of the HTTP request URL. It is
2849 # not settable as a field in the request body.
2850 &quot;remoteService&quot;: &quot;A String&quot;, # Output only. [Output Only]
2851 # If the attachment is on a Cross-Cloud Interconnect connection, this field
2852 # contains the interconnect&#x27;s remote location service provider. Example
2853 # values: &quot;Amazon Web Services&quot; &quot;Microsoft Azure&quot;.
2854 #
2855 # The field is set only for attachments on Cross-Cloud Interconnect
2856 # connections. Its value is copied from the InterconnectRemoteLocation
2857 # remoteService field.
2858 &quot;router&quot;: &quot;A String&quot;, # URL of the Cloud Router to be used for dynamic routing. This router must be
2859 # in the same region as this InterconnectAttachment. The
2860 # InterconnectAttachment will automatically connect the Interconnect to the
2861 # network &amp; region within which the Cloud Router is configured.
2862 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
2863 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
2864 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2865 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this interconnect attachment to identify whether the
2866 # IPv6 feature is enabled or not. If not specified, IPV4_ONLY
2867 # will be used.
2868 #
2869 # This field can be both set at interconnect attachments creation and
2870 # update interconnect attachment operations.
2871 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The current state of this attachment&#x27;s functionality.
2872 # Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE,
2873 # PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values
2874 # PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used
2875 # for only PARTNER and PARTNER_PROVIDER interconnect attachments.
2876 # This state can take one of the following values:
2877 #
2878 # - ACTIVE: The attachment has been turned up and is ready to use.
2879 # - UNPROVISIONED: The attachment is not ready to use yet, because turnup
2880 # is not complete.
2881 # - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet
2882 # been configured on the Partner side.
2883 # - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of
2884 # provisioning after a PARTNER_PROVIDER attachment was created that
2885 # references it.
2886 # - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER
2887 # attachment that is waiting for a customer to activate it.
2888 # - DEFUNCT:
2889 # The attachment was deleted externally and is no longer functional. This
2890 # could be because the associated Interconnect was removed, or because the
2891 # other side of a Partner attachment was deleted.
2892 &quot;subnetLength&quot;: 42, # Input only. Length of the IPv4 subnet mask.
2893 # Allowed values:
2894 #
2895 #
2896 # - 29 (default)
2897 # - 30
2898 #
2899 # The default value is 29, except for Cross-Cloud Interconnect
2900 # connections that use an InterconnectRemoteLocation with a
2901 # constraints.subnetLengthRange.min equal to 30. For example,
2902 # connections that use an Azure remote location fall into this
2903 # category. In these cases, the default value is 30, and requesting
2904 # 29 returns an error.
2905 #
2906 # Where both 29 and 30 are allowed, 29 is preferred, because it gives
2907 # Google Cloud Support more debugging visibility.
2908 &quot;type&quot;: &quot;A String&quot;, # The type of interconnect attachment this is, which can take one of the
2909 # following values:
2910 #
2911 # - DEDICATED: an attachment to a Dedicated Interconnect.
2912 # - PARTNER: an attachment to a Partner Interconnect, created by the
2913 # customer.
2914 # - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by
2915 # the partner.
2916 #
2917 # - L2_DEDICATED: a L2 attachment to a Dedicated Interconnect.
2918 &quot;vlanTag8021q&quot;: 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093.
2919 # Only specified at creation time.
2920 },
2921 ],
2922 &quot;kind&quot;: &quot;compute#interconnectAttachmentList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#interconnectAttachmentList for lists of interconnect
2923 # attachments.
2924 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
2925 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
2926 # the query parameter pageToken in the next list request.
2927 # Subsequent list requests will have their own nextPageToken to
2928 # continue paging through the results.
2929 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
2930 &quot;warning&quot;: { # [Output Only] Informational warning message.
2931 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2932 # Engine returns NO_RESULTS_ON_PAGE if there
2933 # are no results in the response.
2934 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2935 # value format. For example:
2936 #
2937 # &quot;data&quot;: [
2938 # {
2939 # &quot;key&quot;: &quot;scope&quot;,
2940 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2941 # }
2942 {
2943 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2944 # returned. For example, for warnings where there are no results in a list
2945 # request for a particular zone, this key might be scope and
2946 # the key value might be the zone name. Other examples might be a key
2947 # indicating a deprecated resource and a suggested replacement, or a
2948 # warning about invalid network settings (for example, if an instance
2949 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2950 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2951 },
2952 ],
2953 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2954 },
2955 }</pre>
2956 </div>
2957
2958 <div class="method">
2959 <code class="details" id="list_next">list_next()</code>
2960 <pre>Retrieves the next page of results.
2961
2962 Args:
2963 previous_request: The request for the previous page. (required)
2964 previous_response: The response from the request for the previous page. (required)
2965
2966 Returns:
2967 A request object that you can call &#x27;execute()&#x27; on to request the next
2968 page. Returns None if there are no more items in the collection.
2969 </pre>
2970 </div>
2971
2972 <div class="method">
2973 <code class="details" id="patch">patch(project, region, interconnectAttachment, body=None, requestId=None, x__xgafv=None)</code>
2974 <pre>Updates the specified interconnect attachment with the data included in the
2975 request. This method supportsPATCH
2976 semantics and uses theJSON merge
2977 patch format and processing rules.
2978
2979 Args:
2980 project: string, Project ID for this request. (required)
2981 region: string, Name of the region scoping this request. (required)
2982 interconnectAttachment: string, Name of the interconnect attachment to patch. (required)
2983 body: object, The request body.
2984 The object takes the form of:
2985
2986 { # Represents an Interconnect Attachment (VLAN) resource.
2987 #
2988 # You can use Interconnect attachments (VLANS) to connect your Virtual Private
2989 # Cloud networks to your on-premises networks through an Interconnect.
2990 # For more information, read
2991 # Creating VLAN Attachments.
2992 &quot;adminEnabled&quot;: True or False, # Determines whether this Attachment will carry packets.
2993 # Not present for PARTNER_PROVIDER.
2994 &quot;attachmentGroup&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the AttachmentGroup that includes this Attachment.
2995 &quot;bandwidth&quot;: &quot;A String&quot;, # Provisioned bandwidth capacity for the interconnect attachment. For
2996 # attachments of type DEDICATED, the user can set the bandwidth.
2997 # For attachments of type PARTNER, the Google Partner that is operating
2998 # the interconnect must set the bandwidth.
2999 # Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED,
3000 # and can take one of the following values:
3001 #
3002 # - BPS_50M: 50 Mbit/s
3003 # - BPS_100M: 100 Mbit/s
3004 # - BPS_200M: 200 Mbit/s
3005 # - BPS_300M: 300 Mbit/s
3006 # - BPS_400M: 400 Mbit/s
3007 # - BPS_500M: 500 Mbit/s
3008 # - BPS_1G: 1 Gbit/s
3009 # - BPS_2G: 2 Gbit/s
3010 # - BPS_5G: 5 Gbit/s
3011 # - BPS_10G: 10 Gbit/s
3012 # - BPS_20G: 20 Gbit/s
3013 # - BPS_50G: 50 Gbit/s
3014 # - BPS_100G: 100 Gbit/s
3015 # - BPS_400G: 400 Gbit/s
3016 &quot;candidateCloudRouterIpAddress&quot;: &quot;A String&quot;, # Single IPv4 address + prefix length to be configured on the cloud router
3017 # interface for this interconnect attachment.
3018 #
3019 # - Both candidate_cloud_router_ip_address and
3020 # candidate_customer_router_ip_address fields must be set or both must be
3021 # unset.
3022 # - Prefix length of both candidate_cloud_router_ip_address and
3023 # candidate_customer_router_ip_address must be the same.
3024 # - Max prefix length is 31.
3025 &quot;candidateCloudRouterIpv6Address&quot;: &quot;A String&quot;, # Single IPv6 address + prefix length to be configured on the cloud router
3026 # interface for this interconnect attachment.
3027 #
3028 # - Both candidate_cloud_router_ipv6_address and
3029 # candidate_customer_router_ipv6_address fields must be set or both must be
3030 # unset.
3031 # - Prefix length of both candidate_cloud_router_ipv6_address and
3032 # candidate_customer_router_ipv6_address must be the same.
3033 # - Max prefix length is 126.
3034 &quot;candidateCustomerRouterIpAddress&quot;: &quot;A String&quot;, # Single IPv4 address + prefix length to be configured on the customer router
3035 # interface for this interconnect attachment.
3036 &quot;candidateCustomerRouterIpv6Address&quot;: &quot;A String&quot;, # Single IPv6 address + prefix length to be configured on the customer router
3037 # interface for this interconnect attachment.
3038 &quot;candidateIpv6Subnets&quot;: [ # This field is not available.
3039 &quot;A String&quot;,
3040 ],
3041 &quot;candidateSubnets&quot;: [ # Input only. Up to 16 candidate prefixes that can be used to restrict the allocation
3042 # of cloudRouterIpAddress and customerRouterIpAddress for this attachment.
3043 # All prefixes must be within link-local address space (169.254.0.0/16) and
3044 # must be /29 or shorter (/28, /27, etc). Google will attempt to select an
3045 # unused /29 from the supplied candidate prefix(es). The request will fail if
3046 # all possible /29s are in use on Google&#x27;s edge. If not supplied, Google will
3047 # randomly select an unused /29 from all of link-local space.
3048 &quot;A String&quot;,
3049 ],
3050 &quot;cloudRouterIpAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IPv4 address + prefix length to be configured on Cloud Router
3051 # Interface for this interconnect attachment.
3052 &quot;cloudRouterIpv6Address&quot;: &quot;A String&quot;, # Output only. [Output Only] IPv6 address + prefix length to be configured on Cloud
3053 # Router Interface for this interconnect attachment.
3054 &quot;cloudRouterIpv6InterfaceId&quot;: &quot;A String&quot;, # This field is not available.
3055 &quot;configurationConstraints&quot;: { # Output only. [Output Only] Constraints for this attachment, if any. The attachment does
3056 # not work if these constraints are not met.
3057 &quot;bgpMd5&quot;: &quot;A String&quot;, # Output only. [Output Only] Whether the attachment&#x27;s BGP session
3058 # requires/allows/disallows BGP MD5 authentication. This can take one of
3059 # the following values: MD5_OPTIONAL, MD5_REQUIRED, MD5_UNSUPPORTED.
3060 #
3061 # For example, a Cross-Cloud Interconnect connection to a remote cloud
3062 # provider that requires BGP MD5 authentication has the
3063 # interconnectRemoteLocation attachment_configuration_constraints.bgp_md5
3064 # field set to MD5_REQUIRED, and that property is propagated to the
3065 # attachment. Similarly, if BGP MD5 is MD5_UNSUPPORTED, an error is
3066 # returned if MD5 is requested.
3067 &quot;bgpPeerAsnRanges&quot;: [ # Output only. [Output Only] List of ASN ranges that the remote location is known to
3068 # support. Formatted as an array of inclusive ranges {min: min-value, max:
3069 # max-value}. For example, [{min: 123, max: 123}, {min: 64512, max: 65534}]
3070 # allows the peer ASN to be 123 or anything in the range 64512-65534.
3071 #
3072 # This field is only advisory. Although the API accepts other ranges, these
3073 # are the ranges that we recommend.
3074 {
3075 &quot;max&quot;: 42,
3076 &quot;min&quot;: 42,
3077 },
3078 ],
3079 },
3080 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
3081 # text format.
3082 &quot;customerRouterIpAddress&quot;: &quot;A String&quot;, # Output only. [Output Only] IPv4 address + prefix length to be configured on the customer
3083 # router subinterface for this interconnect attachment.
3084 &quot;customerRouterIpv6Address&quot;: &quot;A String&quot;, # Output only. [Output Only] IPv6 address + prefix length to be configured on the
3085 # customer router subinterface for this interconnect attachment.
3086 &quot;customerRouterIpv6InterfaceId&quot;: &quot;A String&quot;, # This field is not available.
3087 &quot;dataplaneVersion&quot;: 42, # Output only. [Output Only] Dataplane version for this InterconnectAttachment. This
3088 # field is only present for Dataplane version 2 and higher. Absence of this
3089 # field in the API output indicates that the Dataplane is version 1.
3090 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource.
3091 &quot;edgeAvailabilityDomain&quot;: &quot;A String&quot;, # Input only. Desired availability domain for the attachment. Only available for type
3092 # PARTNER, at creation time, and can take one of the following values:
3093 #
3094 # - AVAILABILITY_DOMAIN_ANY
3095 # - AVAILABILITY_DOMAIN_1
3096 # - AVAILABILITY_DOMAIN_2
3097 #
3098 #
3099 # For improved reliability, customers should configure a pair of attachments,
3100 # one per availability domain. The selected availability domain will be
3101 # provided to the Partner via the pairing key, so that the provisioned
3102 # circuit will lie in the specified domain. If not specified, the value will
3103 # default to AVAILABILITY_DOMAIN_ANY.
3104 &quot;encryption&quot;: &quot;A String&quot;, # Indicates the user-supplied encryption option of this VLAN attachment
3105 # (interconnectAttachment). Can only be specified at attachment creation
3106 # for PARTNER or DEDICATED attachments.
3107 # Possible values are:
3108 #
3109 # - NONE - This is the default value, which means that the
3110 # VLAN attachment carries unencrypted traffic. VMs are able to send
3111 # traffic to, or receive traffic from, such a VLAN attachment.
3112 # - IPSEC - The VLAN attachment carries only encrypted
3113 # traffic that is encrypted by an IPsec device, such as an HA VPN gateway or
3114 # third-party IPsec VPN. VMs cannot directly send traffic to, or receive
3115 # traffic from, such a VLAN attachment. To use *HA VPN over Cloud
3116 # Interconnect*, the VLAN attachment must be created with this
3117 # option.
3118 &quot;googleReferenceId&quot;: &quot;A String&quot;, # Output only. [Output Only] Google reference ID, to be used when raising support tickets
3119 # with Google or otherwise to debug backend connectivity issues.
3120 # [Deprecated] This field is not used.
3121 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
3122 # defined by the server.
3123 &quot;interconnect&quot;: &quot;A String&quot;, # URL of the underlying Interconnect object that this attachment&#x27;s traffic
3124 # will traverse through.
3125 &quot;ipsecInternalAddresses&quot;: [ # A list of URLs of addresses that have been reserved for the VLAN
3126 # attachment. Used only for the VLAN attachment that has the encryption
3127 # option as IPSEC. The addresses must be regional internal IP address ranges.
3128 # When creating an HA VPN gateway over the VLAN attachment, if the attachment
3129 # is configured to use a regional internal IP address, then the VPN gateway&#x27;s
3130 # IP address is allocated from the IP address range specified here. For
3131 # example, if the HA VPN gateway&#x27;s interface 0 is paired to this VLAN
3132 # attachment, then a regional internal IP address for the VPN gateway
3133 # interface 0 will be allocated from the IP address specified for this
3134 # VLAN attachment.
3135 # If this field is not specified when creating the VLAN attachment, then
3136 # later on when creating an HA VPN gateway on this VLAN attachment, the HA
3137 # VPN gateway&#x27;s IP address is allocated from the regional external IP address
3138 # pool.
3139 &quot;A String&quot;,
3140 ],
3141 &quot;kind&quot;: &quot;compute#interconnectAttachment&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#interconnectAttachment for interconnect attachments.
3142 &quot;l2Forwarding&quot;: { # L2 Interconnect Attachment related configuration. # L2 Interconnect Attachment related config. This field is required if the
3143 # type is L2_DEDICATED.
3144 #
3145 # The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad)
3146 # within L2 packets are mapped to the destination appliances IP addresses.
3147 # The packet is then encapsulated with the appliance IP address and sent to
3148 # the edge appliance.
3149 &quot;applianceMappings&quot;: { # Optional. A map of VLAN tags to appliances and optional inner mapping
3150 # rules. If VLANs are not explicitly mapped to any appliance, the
3151 # defaultApplianceIpAddress is used.
3152 #
3153 # Each VLAN tag can be a single number or a range of numbers in the range
3154 # of 1 to 4094, e.g., &quot;1&quot; or &quot;4001-4094&quot;. Non-empty and non-overlapping
3155 # VLAN tag ranges are enforced, and violating operations will be rejected.
3156 #
3157 # The VLAN tags in the Ethernet header must use an ethertype value of
3158 # 0x88A8 or 0x8100.
3159 &quot;a_key&quot;: { # Two-level VLAN-to-Appliance mapping rule.
3160 &quot;applianceIpAddress&quot;: &quot;A String&quot;, # Optional. A single IPv4 or IPv6 address used as the destination IP
3161 # address for ingress packets that match on a VLAN tag, but do not match
3162 # a more specific inner VLAN tag.
3163 #
3164 # Unset field (null-value) indicates both VLAN tags are required to be
3165 # mapped. Otherwise, defaultApplianceIpAddress is used.
3166 &quot;innerVlanToApplianceMappings&quot;: [ # Optional. Used to match against the inner VLAN when the packet
3167 # contains two VLAN tags.
3168 #
3169 # A list of mapping rules from inner VLAN tags to IP addresses. If the
3170 # inner VLAN is not explicitly mapped to an IP address range, the
3171 # applianceIpAddress is used.
3172 { # The inner VLAN-to-Appliance mapping.
3173 &quot;innerApplianceIpAddress&quot;: &quot;A String&quot;, # Required in this object. A single IPv4 or IPv6 address used as the
3174 # destination IP address for ingress packets that match on both VLAN
3175 # tags.
3176 &quot;innerVlanTags&quot;: [ # Required in this object. Used to match the inner VLAN tag on the
3177 # packet. Each entry can be a single number or a range of numbers in
3178 # the range of 1 to 4094, e.g., [&quot;1&quot;, &quot;4001-4094&quot;] is valid. Non-empty
3179 # and Non-overlapping VLAN tag ranges are enforced, and violating
3180 # operations will be rejected.
3181 #
3182 # The inner VLAN tags must have an ethertype value of 0x8100.
3183 &quot;A String&quot;,
3184 ],
3185 },
3186 ],
3187 &quot;name&quot;: &quot;A String&quot;, # Optional. The name of this appliance mapping rule.
3188 },
3189 },
3190 &quot;defaultApplianceIpAddress&quot;: &quot;A String&quot;, # Optional. A single IPv4 or IPv6 address used as the default destination
3191 # IP when there is no VLAN mapping result found.
3192 #
3193 # Unset field (null-value) indicates the unmatched packet should be
3194 # dropped.
3195 &quot;geneveHeader&quot;: { # GeneveHeader related configurations. # Optional. It represents the structure of a Geneve (Generic Network
3196 # Virtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various
3197 # protocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization
3198 # environments.
3199 &quot;vni&quot;: 42, # Optional. VNI is a 24-bit unique virtual network identifier, from 0 to
3200 # 16,777,215.
3201 },
3202 &quot;network&quot;: &quot;A String&quot;, # Required. Resource URL of the network to which this attachment belongs.
3203 &quot;tunnelEndpointIpAddress&quot;: &quot;A String&quot;, # Required. A single IPv4 or IPv6 address. This address will be used as the
3204 # source IP address for packets sent to the appliances, and must be used as
3205 # the destination IP address for packets that should be sent out through
3206 # this attachment.
3207 },
3208 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this InterconnectAttachment,
3209 # which is essentially a hash of the labels set used for optimistic locking.
3210 # The fingerprint is initially generated by Compute Engine and changes after
3211 # every request to modify or update labels. You must always provide an
3212 # up-to-date fingerprint hash in order to update or change labels,
3213 # otherwise the request will fail with error412 conditionNotMet.
3214 #
3215 # To see the latest fingerprint, make a get() request to
3216 # retrieve an InterconnectAttachment.
3217 &quot;labels&quot;: { # Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
3218 # Label values may be empty.
3219 &quot;a_key&quot;: &quot;A String&quot;,
3220 },
3221 &quot;mtu&quot;: 42, # Maximum Transmission Unit (MTU), in bytes, of packets passing through this
3222 # interconnect attachment.
3223 # Valid values are 1440, 1460, 1500, and 8896. If not specified,
3224 # the value will default to 1440.
3225 &quot;multicastEnabled&quot;: True or False, # Whether or not to permit multicast traffic for this attachment. Multicast
3226 # packets will be dropped if this is not enabled.
3227 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
3228 # The name must be 1-63 characters long, and comply withRFC1035.
3229 # Specifically, the name must be 1-63 characters long and match the regular
3230 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
3231 # character must be a lowercase letter, and all following characters must
3232 # be a dash, lowercase letter, or digit, except the last character, which
3233 # cannot be a dash.
3234 &quot;operationalStatus&quot;: &quot;A String&quot;, # Output only. [Output Only] The current status of whether or not this interconnect
3235 # attachment is functional, which can take one of the following values:
3236 #
3237 # - OS_ACTIVE: The attachment has been turned up and is ready to
3238 # use.
3239 # - OS_UNPROVISIONED: The attachment is not ready to use yet,
3240 # because turnup is not complete.
3241 &quot;pairingKey&quot;: &quot;A String&quot;, # [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not
3242 # present for DEDICATED].
3243 # The opaque identifier of a PARTNER attachment used to initiate
3244 # provisioning with a selected partner.
3245 # Of the form &quot;XXXXX/region/domain&quot;
3246 &quot;params&quot;: { # Additional interconnect attachment parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
3247 # as part of resource payload.
3248 &quot;resourceManagerTags&quot;: { # Tag keys/values directly bound to this resource.
3249 # Tag keys and values have the same definition as resource
3250 # manager tags. The field is allowed for INSERT
3251 # only. The keys/values to set on the resource should be specified in
3252 # either ID { : } or Namespaced format
3253 # { : }.
3254 # For example the following are valid inputs:
3255 # * {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;tagKeys/123&quot; : &quot;tagValues/456&quot;}
3256 # * {&quot;123/environment&quot; : &quot;production&quot;, &quot;345/abc&quot; : &quot;xyz&quot;}
3257 # Note:
3258 # * Invalid combinations of ID &amp; namespaced format is not supported. For
3259 # instance: {&quot;123/environment&quot; : &quot;tagValues/444&quot;} is invalid.
3260 # * Inconsistent format is not supported. For instance:
3261 # {&quot;tagKeys/333&quot; : &quot;tagValues/444&quot;, &quot;123/env&quot; : &quot;prod&quot;} is invalid.
3262 &quot;a_key&quot;: &quot;A String&quot;,
3263 },
3264 },
3265 &quot;partnerAsn&quot;: &quot;A String&quot;, # Optional BGP ASN for the router supplied by a Layer 3 Partner if they
3266 # configured BGP on behalf of the customer.
3267 # Output only for PARTNER type, input only for PARTNER_PROVIDER, not
3268 # available for DEDICATED.
3269 &quot;partnerMetadata&quot;: { # Informational metadata about Partner attachments from Partners to display # Informational metadata about Partner attachments from Partners to display
3270 # to customers.
3271 # Output only for PARTNER type, mutable for PARTNER_PROVIDER, not
3272 # available for DEDICATED.
3273 # to customers. These fields are propagated from PARTNER_PROVIDER
3274 # attachments to their corresponding PARTNER attachments.
3275 &quot;interconnectName&quot;: &quot;A String&quot;, # Plain text name of the Interconnect this attachment is connected to, as
3276 # displayed in the Partner&#x27;s portal. For instance &quot;Chicago 1&quot;.
3277 # This value may be validated to match approved Partner values.
3278 &quot;partnerName&quot;: &quot;A String&quot;, # Plain text name of the Partner providing this attachment.
3279 # This value may be validated to match approved Partner values.
3280 &quot;portalUrl&quot;: &quot;A String&quot;, # URL of the Partner&#x27;s portal for this Attachment. Partners may customise
3281 # this to be a deep link to the specific resource on the Partner portal.
3282 # This value may be validated to match approved Partner values.
3283 },
3284 &quot;privateInterconnectInfo&quot;: { # Information for an interconnect attachment when this belongs to an # Output only. [Output Only] Information specific to an InterconnectAttachment.
3285 # This property is populated if the interconnect that
3286 # this is attached to is of type DEDICATED.
3287 # interconnect of type DEDICATED.
3288 &quot;tag8021q&quot;: 42, # [Output Only] 802.1q encapsulation tag to be used for traffic between
3289 # Google and the customer, going to and from this network and region.
3290 },
3291 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the regional interconnect attachment
3292 # resides.
3293 # You must specify this field as part of the HTTP request URL. It is
3294 # not settable as a field in the request body.
3295 &quot;remoteService&quot;: &quot;A String&quot;, # Output only. [Output Only]
3296 # If the attachment is on a Cross-Cloud Interconnect connection, this field
3297 # contains the interconnect&#x27;s remote location service provider. Example
3298 # values: &quot;Amazon Web Services&quot; &quot;Microsoft Azure&quot;.
3299 #
3300 # The field is set only for attachments on Cross-Cloud Interconnect
3301 # connections. Its value is copied from the InterconnectRemoteLocation
3302 # remoteService field.
3303 &quot;router&quot;: &quot;A String&quot;, # URL of the Cloud Router to be used for dynamic routing. This router must be
3304 # in the same region as this InterconnectAttachment. The
3305 # InterconnectAttachment will automatically connect the Interconnect to the
3306 # network &amp; region within which the Cloud Router is configured.
3307 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
3308 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
3309 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
3310 &quot;stackType&quot;: &quot;A String&quot;, # The stack type for this interconnect attachment to identify whether the
3311 # IPv6 feature is enabled or not. If not specified, IPV4_ONLY
3312 # will be used.
3313 #
3314 # This field can be both set at interconnect attachments creation and
3315 # update interconnect attachment operations.
3316 &quot;state&quot;: &quot;A String&quot;, # Output only. [Output Only] The current state of this attachment&#x27;s functionality.
3317 # Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE,
3318 # PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values
3319 # PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used
3320 # for only PARTNER and PARTNER_PROVIDER interconnect attachments.
3321 # This state can take one of the following values:
3322 #
3323 # - ACTIVE: The attachment has been turned up and is ready to use.
3324 # - UNPROVISIONED: The attachment is not ready to use yet, because turnup
3325 # is not complete.
3326 # - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet
3327 # been configured on the Partner side.
3328 # - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of
3329 # provisioning after a PARTNER_PROVIDER attachment was created that
3330 # references it.
3331 # - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER
3332 # attachment that is waiting for a customer to activate it.
3333 # - DEFUNCT:
3334 # The attachment was deleted externally and is no longer functional. This
3335 # could be because the associated Interconnect was removed, or because the
3336 # other side of a Partner attachment was deleted.
3337 &quot;subnetLength&quot;: 42, # Input only. Length of the IPv4 subnet mask.
3338 # Allowed values:
3339 #
3340 #
3341 # - 29 (default)
3342 # - 30
3343 #
3344 # The default value is 29, except for Cross-Cloud Interconnect
3345 # connections that use an InterconnectRemoteLocation with a
3346 # constraints.subnetLengthRange.min equal to 30. For example,
3347 # connections that use an Azure remote location fall into this
3348 # category. In these cases, the default value is 30, and requesting
3349 # 29 returns an error.
3350 #
3351 # Where both 29 and 30 are allowed, 29 is preferred, because it gives
3352 # Google Cloud Support more debugging visibility.
3353 &quot;type&quot;: &quot;A String&quot;, # The type of interconnect attachment this is, which can take one of the
3354 # following values:
3355 #
3356 # - DEDICATED: an attachment to a Dedicated Interconnect.
3357 # - PARTNER: an attachment to a Partner Interconnect, created by the
3358 # customer.
3359 # - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by
3360 # the partner.
3361 #
3362 # - L2_DEDICATED: a L2 attachment to a Dedicated Interconnect.
3363 &quot;vlanTag8021q&quot;: 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093.
3364 # Only specified at creation time.
3365 }
3366
3367 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
3368 that if you must retry your request, the server will know to ignore the
3369 request if it has already been completed.
3370
3371 For example, consider a situation where you make an initial request and
3372 the request times out. If you make the request again with the same
3373 request ID, the server can check if original operation with the same
3374 request ID was received, and if so, will ignore the second request. This
3375 prevents clients from accidentally creating duplicate commitments.
3376
3377 The request ID must be
3378 a valid UUID with the exception that zero UUID is not supported
3379 (00000000-0000-0000-0000-000000000000).
3380 x__xgafv: string, V1 error format.
3381 Allowed values
3382 1 - v1 error format
3383 2 - v2 error format
3384
3385 Returns:
3386 An object of the form:
3387
3388 { # Represents an Operation resource.
3389 #
3390 # Google Compute Engine has three Operation resources:
3391 #
3392 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
3393 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
3394 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
3395 #
3396 # You can use an operation resource to manage asynchronous API requests.
3397 # For more information, readHandling
3398 # API responses.
3399 #
3400 # Operations can be global, regional or zonal.
3401 #
3402 # - For global operations, use the `globalOperations`
3403 # resource.
3404 # - For regional operations, use the
3405 # `regionOperations` resource.
3406 # - For zonal operations, use
3407 # the `zoneOperations` resource.
3408 #
3409 #
3410 #
3411 # For more information, read
3412 # Global, Regional, and Zonal Resources.
3413 #
3414 # Note that completed Operation resources have a limited
3415 # retention period.
3416 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
3417 # Not present otherwise.
3418 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3419 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
3420 # set when the operation is created.
3421 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
3422 # text format.
3423 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
3424 # this field will be populated.
3425 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3426 # operation.
3427 {
3428 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3429 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3430 # details. There is a set of defined message types to use for providing
3431 # details.The syntax depends on the error code. For example,
3432 # QuotaExceededInfo will have details when the error code is
3433 # QUOTA_EXCEEDED.
3434 {
3435 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3436 #
3437 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3438 # is not enabled:
3439 #
3440 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3441 # &quot;domain&quot;: &quot;googleapis.com&quot;
3442 # &quot;metadata&quot;: {
3443 # &quot;resource&quot;: &quot;projects/123&quot;,
3444 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3445 # }
3446 # }
3447 #
3448 # This response indicates that the pubsub.googleapis.com API is not enabled.
3449 #
3450 # Example of an error that is returned when attempting to create a Spanner
3451 # instance in a region that is out of stock:
3452 #
3453 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3454 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3455 # &quot;metadata&quot;: {
3456 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3457 # }
3458 # }
3459 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3460 # is typically the registered service name of the tool or product that
3461 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3462 # generated by some common infrastructure, the error domain must be a
3463 # globally unique value that identifies the infrastructure. For Google API
3464 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3465 &quot;metadatas&quot;: { # Additional structured details about this error.
3466 #
3467 # Keys must match a regular expression of `a-z+` but should
3468 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3469 # length. When identifying the current value of an exceeded limit, the units
3470 # should be contained in the key, not the value. For example, rather than
3471 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3472 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3473 # instances that can be created in a single (batch) request.
3474 &quot;a_key&quot;: &quot;A String&quot;,
3475 },
3476 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3477 # proximate cause of the error. Error reasons are unique within a particular
3478 # domain of errors. This should be at most 63 characters and match a
3479 # regular expression of `A-Z+[A-Z0-9]`, which represents
3480 # UPPER_SNAKE_CASE.
3481 },
3482 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3483 #
3484 # For example, if a quota check failed with an error indicating the calling
3485 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3486 # directly to the right place in the developer console to flip the bit.
3487 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3488 { # Describes a URL link.
3489 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3490 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3491 },
3492 ],
3493 },
3494 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3495 # which can be attached to an RPC error.
3496 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3497 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3498 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3499 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3500 },
3501 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3502 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3503 &quot;a_key&quot;: &quot;A String&quot;,
3504 },
3505 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3506 # type or metric.
3507 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3508 # or metric.
3509 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3510 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3511 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3512 },
3513 },
3514 ],
3515 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3516 # This property is optional.
3517 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3518 },
3519 ],
3520 },
3521 &quot;getVersionOperationMetadata&quot;: {
3522 &quot;inlineSbomInfo&quot;: {
3523 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
3524 # appropriate identifiers.
3525 &quot;a_key&quot;: &quot;A String&quot;,
3526 },
3527 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
3528 # identifiers.
3529 &quot;a_key&quot;: &quot;A String&quot;,
3530 },
3531 },
3532 },
3533 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
3534 # message that was returned, such as `NOT FOUND`.
3535 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
3536 # status code that was returned. For example, a `404` means the
3537 # resource was not found.
3538 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
3539 # defined by the server.
3540 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
3541 # This value is inRFC3339
3542 # text format.
3543 &quot;instancesBulkInsertOperationMetadata&quot;: {
3544 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
3545 # Example key: zones/us-central1-a
3546 &quot;a_key&quot;: {
3547 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
3548 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
3549 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
3550 # error.
3551 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
3552 # if the flow is rolling forward or rolling back.
3553 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
3554 },
3555 },
3556 },
3557 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
3558 # Operation resources.
3559 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
3560 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
3561 # group of operations results from a `bulkInsert` API request.
3562 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
3563 # `update`, or `delete`, and so on.
3564 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
3565 # There is no requirement that this be linear or support any granularity of
3566 # operations. This should not be used to guess when the operation will be
3567 # complete. This number should monotonically increase as the operation
3568 # progresses.
3569 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
3570 # applicable when performing regional operations.
3571 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3572 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
3573 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
3574 # this field will contain information on all underlying zonal actions and
3575 # their state.
3576 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
3577 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
3578 # Example key: zones/us-central1-a
3579 &quot;a_key&quot;: {
3580 &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
3581 # populated.
3582 # different programming environments, including REST APIs and RPC APIs. It is
3583 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3584 # three pieces of data: error code, error message, and error details.
3585 #
3586 # You can find out more about this error model and how to work with it in the
3587 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3588 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
3589 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
3590 # message types for APIs to use.
3591 {
3592 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3593 },
3594 ],
3595 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
3596 # user-facing error message should be localized and sent in the
3597 # google.rpc.Status.details field, or localized by the client.
3598 },
3599 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
3600 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
3601 },
3602 },
3603 },
3604 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
3605 # This value is inRFC3339
3606 # text format.
3607 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
3608 # following:
3609 # `PENDING`, `RUNNING`, or `DONE`.
3610 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
3611 # operation.
3612 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
3613 # of the target resource.
3614 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
3615 # operations related to creating a snapshot, this points to the disk
3616 # that the snapshot was created from.
3617 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
3618 # `[email protected]` or
3619 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
3620 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
3621 # operation, this field will be populated.
3622 {
3623 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3624 # Engine returns NO_RESULTS_ON_PAGE if there
3625 # are no results in the response.
3626 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3627 # value format. For example:
3628 #
3629 # &quot;data&quot;: [
3630 # {
3631 # &quot;key&quot;: &quot;scope&quot;,
3632 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3633 # }
3634 {
3635 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3636 # returned. For example, for warnings where there are no results in a list
3637 # request for a particular zone, this key might be scope and
3638 # the key value might be the zone name. Other examples might be a key
3639 # indicating a deprecated resource and a suggested replacement, or a
3640 # warning about invalid network settings (for example, if an instance
3641 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3642 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3643 },
3644 ],
3645 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3646 },
3647 ],
3648 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
3649 # applicable when performing per-zone operations.
3650 }</pre>
3651 </div>
3652
3653 <div class="method">
3654 <code class="details" id="setIamPolicy">setIamPolicy(project, region, resource, body=None, x__xgafv=None)</code>
3655 <pre>Sets the access control policy on the specified resource.
3656 Replaces any existing policy.
3657
3658 Args:
3659 project: string, Project ID for this request. (required)
3660 region: string, The name of the region for this request. (required)
3661 resource: string, Name or id of the resource for this request. (required)
3662 body: object, The request body.
3663 The object takes the form of:
3664
3665 {
3666 &quot;bindings&quot;: [ # Flatten Policy to create a backwacd compatible wire-format.
3667 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
3668 { # Associates `members`, or principals, with a `role`.
3669 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
3670 #
3671 # If the condition evaluates to `true`, then this binding applies to the
3672 # current request.
3673 #
3674 # If the condition evaluates to `false`, then this binding does not apply to
3675 # the current request. However, a different role binding might grant the same
3676 # role to one or more of the principals in this binding.
3677 #
3678 # To learn which resources support conditions in their IAM policies, see the
3679 # [IAM
3680 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3681 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
3682 # are documented at https://github.com/google/cel-spec.
3683 #
3684 # Example (Comparison):
3685 #
3686 # title: &quot;Summary size limit&quot;
3687 # description: &quot;Determines if a summary is less than 100 chars&quot;
3688 # expression: &quot;document.summary.size() &lt; 100&quot;
3689 #
3690 # Example (Equality):
3691 #
3692 # title: &quot;Requestor is owner&quot;
3693 # description: &quot;Determines if requestor is the document owner&quot;
3694 # expression: &quot;document.owner == request.auth.claims.email&quot;
3695 #
3696 # Example (Logic):
3697 #
3698 # title: &quot;Public documents&quot;
3699 # description: &quot;Determine whether the document should be publicly visible&quot;
3700 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
3701 #
3702 # Example (Data Manipulation):
3703 #
3704 # title: &quot;Notification string&quot;
3705 # description: &quot;Create a notification string with a timestamp.&quot;
3706 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
3707 #
3708 # The exact variables and functions that may be referenced within an expression
3709 # are determined by the service that evaluates it. See the service
3710 # documentation for additional information.
3711 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
3712 # describes the expression, e.g. when hovered over it in a UI.
3713 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
3714 # syntax.
3715 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
3716 # reporting, e.g. a file name and a position in the file.
3717 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
3718 # its purpose. This can be used e.g. in UIs which allow to enter the
3719 # expression.
3720 },
3721 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
3722 # `members` can have the following values:
3723 #
3724 # * `allUsers`: A special identifier that represents anyone who is
3725 # on the internet; with or without a Google account.
3726 #
3727 # * `allAuthenticatedUsers`: A special identifier that represents anyone
3728 # who is authenticated with a Google account or a service account.
3729 # Does not include identities that come from external identity providers
3730 # (IdPs) through identity federation.
3731 #
3732 # * `user:{emailid}`: An email address that represents a specific Google
3733 # account. For example, `[email protected]` .
3734 #
3735 #
3736 # * `serviceAccount:{emailid}`: An email address that represents a Google
3737 # service account. For example,
3738 # `[email protected]`.
3739 #
3740 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
3741 # identifier for a
3742 # [Kubernetes service
3743 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
3744 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
3745 #
3746 # * `group:{emailid}`: An email address that represents a Google group.
3747 # For example, `[email protected]`.
3748 #
3749 #
3750 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
3751 # users of that domain. For example, `google.com` or `example.com`.
3752 #
3753 #
3754 #
3755 #
3756 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3757 # A single identity in a workforce identity pool.
3758 #
3759 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
3760 # All workforce identities in a group.
3761 #
3762 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3763 # All workforce identities with a specific attribute value.
3764 #
3765 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
3766 # All identities in a workforce identity pool.
3767 #
3768 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
3769 # A single identity in a workload identity pool.
3770 #
3771 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
3772 # A workload identity pool group.
3773 #
3774 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3775 # All identities in a workload identity pool with a certain attribute.
3776 #
3777 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
3778 # All identities in a workload identity pool.
3779 #
3780 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
3781 # identifier) representing a user that has been recently deleted. For
3782 # example, `[email protected]?uid=123456789012345678901`. If the user is
3783 # recovered, this value reverts to `user:{emailid}` and the recovered user
3784 # retains the role in the binding.
3785 #
3786 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
3787 # unique identifier) representing a service account that has been recently
3788 # deleted. For example,
3789 # `[email protected]?uid=123456789012345678901`.
3790 # If the service account is undeleted, this value reverts to
3791 # `serviceAccount:{emailid}` and the undeleted service account retains the
3792 # role in the binding.
3793 #
3794 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
3795 # identifier) representing a Google group that has been recently
3796 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
3797 # the group is recovered, this value reverts to `group:{emailid}` and the
3798 # recovered group retains the role in the binding.
3799 #
3800 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3801 # Deleted single identity in a workforce identity pool. For example,
3802 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
3803 &quot;A String&quot;,
3804 ],
3805 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
3806 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
3807 #
3808 # For an overview of the IAM roles and permissions, see the
3809 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
3810 # a list of the available pre-defined roles, see
3811 # [here](https://cloud.google.com/iam/docs/understanding-roles).
3812 },
3813 ],
3814 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
3815 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
3816 &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
3817 # the policy is limited to a few 10s of KB. An empty policy is in general a
3818 # valid policy but certain services (like Projects) might reject them.
3819 # controls for Google Cloud resources.
3820 #
3821 #
3822 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
3823 # `members`, or principals, to a single `role`. Principals can be user
3824 # accounts, service accounts, Google groups, and domains (such as G Suite). A
3825 # `role` is a named list of permissions; each `role` can be an IAM predefined
3826 # role or a user-created custom role.
3827 #
3828 # For some types of Google Cloud resources, a `binding` can also specify a
3829 # `condition`, which is a logical expression that allows access to a resource
3830 # only if the expression evaluates to `true`. A condition can add constraints
3831 # based on attributes of the request, the resource, or both. To learn which
3832 # resources support conditions in their IAM policies, see the
3833 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3834 #
3835 # **JSON example:**
3836 #
3837 # ```
3838 # {
3839 # &quot;bindings&quot;: [
3840 # {
3841 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
3842 # &quot;members&quot;: [
3843 # &quot;user:[email protected]&quot;,
3844 # &quot;group:[email protected]&quot;,
3845 # &quot;domain:google.com&quot;,
3846 # &quot;serviceAccount:[email protected]&quot;
3847 # ]
3848 # },
3849 # {
3850 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
3851 # &quot;members&quot;: [
3852 # &quot;user:[email protected]&quot;
3853 # ],
3854 # &quot;condition&quot;: {
3855 # &quot;title&quot;: &quot;expirable access&quot;,
3856 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
3857 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
3858 # }
3859 # }
3860 # ],
3861 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
3862 # &quot;version&quot;: 3
3863 # }
3864 # ```
3865 #
3866 # **YAML example:**
3867 #
3868 # ```
3869 # bindings:
3870 # - members:
3871 # - user:[email protected]
3872 # - group:[email protected]
3873 # - domain:google.com
3874 # - serviceAccount:[email protected]
3875 # role: roles/resourcemanager.organizationAdmin
3876 # - members:
3877 # - user:[email protected]
3878 # role: roles/resourcemanager.organizationViewer
3879 # condition:
3880 # title: expirable access
3881 # description: Does not grant access after Sep 2020
3882 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
3883 # etag: BwWWja0YfJA=
3884 # version: 3
3885 # ```
3886 #
3887 # For a description of IAM and its features, see the
3888 # [IAM documentation](https://cloud.google.com/iam/docs/).
3889 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
3890 { # Specifies the audit configuration for a service.
3891 # The configuration determines which permission types are logged, and what
3892 # identities, if any, are exempted from logging.
3893 # An AuditConfig must have one or more AuditLogConfigs.
3894 #
3895 # If there are AuditConfigs for both `allServices` and a specific service,
3896 # the union of the two AuditConfigs is used for that service: the log_types
3897 # specified in each AuditConfig are enabled, and the exempted_members in each
3898 # AuditLogConfig are exempted.
3899 #
3900 # Example Policy with multiple AuditConfigs:
3901 #
3902 # {
3903 # &quot;audit_configs&quot;: [
3904 # {
3905 # &quot;service&quot;: &quot;allServices&quot;,
3906 # &quot;audit_log_configs&quot;: [
3907 # {
3908 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3909 # &quot;exempted_members&quot;: [
3910 # &quot;user:[email protected]&quot;
3911 # ]
3912 # },
3913 # {
3914 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3915 # },
3916 # {
3917 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
3918 # }
3919 # ]
3920 # },
3921 # {
3922 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
3923 # &quot;audit_log_configs&quot;: [
3924 # {
3925 # &quot;log_type&quot;: &quot;DATA_READ&quot;
3926 # },
3927 # {
3928 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
3929 # &quot;exempted_members&quot;: [
3930 # &quot;user:[email protected]&quot;
3931 # ]
3932 # }
3933 # ]
3934 # }
3935 # ]
3936 # }
3937 #
3938 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
3939 # logging. It also exempts `[email protected]` from DATA_READ logging, and
3940 # `[email protected]` from DATA_WRITE logging.
3941 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
3942 { # Provides the configuration for logging a type of permissions.
3943 # Example:
3944 #
3945 # {
3946 # &quot;audit_log_configs&quot;: [
3947 # {
3948 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3949 # &quot;exempted_members&quot;: [
3950 # &quot;user:[email protected]&quot;
3951 # ]
3952 # },
3953 # {
3954 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3955 # }
3956 # ]
3957 # }
3958 #
3959 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
3960 # [email protected] from DATA_READ logging.
3961 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
3962 # permission.
3963 # Follows the same format of Binding.members.
3964 &quot;A String&quot;,
3965 ],
3966 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
3967 },
3968 ],
3969 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
3970 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
3971 # `allServices` is a special value that covers all services.
3972 },
3973 ],
3974 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
3975 # may specify a `condition` that determines how and when the `bindings` are
3976 # applied. Each of the `bindings` must contain at least one principal.
3977 #
3978 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
3979 # of these principals can be Google groups. Each occurrence of a principal
3980 # counts towards these limits. For example, if the `bindings` grant 50
3981 # different roles to `user:[email protected]`, and not to any other
3982 # principal, then you can add another 1,450 principals to the `bindings` in
3983 # the `Policy`.
3984 { # Associates `members`, or principals, with a `role`.
3985 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
3986 #
3987 # If the condition evaluates to `true`, then this binding applies to the
3988 # current request.
3989 #
3990 # If the condition evaluates to `false`, then this binding does not apply to
3991 # the current request. However, a different role binding might grant the same
3992 # role to one or more of the principals in this binding.
3993 #
3994 # To learn which resources support conditions in their IAM policies, see the
3995 # [IAM
3996 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3997 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
3998 # are documented at https://github.com/google/cel-spec.
3999 #
4000 # Example (Comparison):
4001 #
4002 # title: &quot;Summary size limit&quot;
4003 # description: &quot;Determines if a summary is less than 100 chars&quot;
4004 # expression: &quot;document.summary.size() &lt; 100&quot;
4005 #
4006 # Example (Equality):
4007 #
4008 # title: &quot;Requestor is owner&quot;
4009 # description: &quot;Determines if requestor is the document owner&quot;
4010 # expression: &quot;document.owner == request.auth.claims.email&quot;
4011 #
4012 # Example (Logic):
4013 #
4014 # title: &quot;Public documents&quot;
4015 # description: &quot;Determine whether the document should be publicly visible&quot;
4016 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
4017 #
4018 # Example (Data Manipulation):
4019 #
4020 # title: &quot;Notification string&quot;
4021 # description: &quot;Create a notification string with a timestamp.&quot;
4022 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
4023 #
4024 # The exact variables and functions that may be referenced within an expression
4025 # are determined by the service that evaluates it. See the service
4026 # documentation for additional information.
4027 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
4028 # describes the expression, e.g. when hovered over it in a UI.
4029 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
4030 # syntax.
4031 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
4032 # reporting, e.g. a file name and a position in the file.
4033 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
4034 # its purpose. This can be used e.g. in UIs which allow to enter the
4035 # expression.
4036 },
4037 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
4038 # `members` can have the following values:
4039 #
4040 # * `allUsers`: A special identifier that represents anyone who is
4041 # on the internet; with or without a Google account.
4042 #
4043 # * `allAuthenticatedUsers`: A special identifier that represents anyone
4044 # who is authenticated with a Google account or a service account.
4045 # Does not include identities that come from external identity providers
4046 # (IdPs) through identity federation.
4047 #
4048 # * `user:{emailid}`: An email address that represents a specific Google
4049 # account. For example, `[email protected]` .
4050 #
4051 #
4052 # * `serviceAccount:{emailid}`: An email address that represents a Google
4053 # service account. For example,
4054 # `[email protected]`.
4055 #
4056 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
4057 # identifier for a
4058 # [Kubernetes service
4059 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
4060 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
4061 #
4062 # * `group:{emailid}`: An email address that represents a Google group.
4063 # For example, `[email protected]`.
4064 #
4065 #
4066 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
4067 # users of that domain. For example, `google.com` or `example.com`.
4068 #
4069 #
4070 #
4071 #
4072 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
4073 # A single identity in a workforce identity pool.
4074 #
4075 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
4076 # All workforce identities in a group.
4077 #
4078 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
4079 # All workforce identities with a specific attribute value.
4080 #
4081 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
4082 # All identities in a workforce identity pool.
4083 #
4084 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
4085 # A single identity in a workload identity pool.
4086 #
4087 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
4088 # A workload identity pool group.
4089 #
4090 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
4091 # All identities in a workload identity pool with a certain attribute.
4092 #
4093 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
4094 # All identities in a workload identity pool.
4095 #
4096 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
4097 # identifier) representing a user that has been recently deleted. For
4098 # example, `[email protected]?uid=123456789012345678901`. If the user is
4099 # recovered, this value reverts to `user:{emailid}` and the recovered user
4100 # retains the role in the binding.
4101 #
4102 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
4103 # unique identifier) representing a service account that has been recently
4104 # deleted. For example,
4105 # `[email protected]?uid=123456789012345678901`.
4106 # If the service account is undeleted, this value reverts to
4107 # `serviceAccount:{emailid}` and the undeleted service account retains the
4108 # role in the binding.
4109 #
4110 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
4111 # identifier) representing a Google group that has been recently
4112 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
4113 # the group is recovered, this value reverts to `group:{emailid}` and the
4114 # recovered group retains the role in the binding.
4115 #
4116 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
4117 # Deleted single identity in a workforce identity pool. For example,
4118 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
4119 &quot;A String&quot;,
4120 ],
4121 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
4122 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
4123 #
4124 # For an overview of the IAM roles and permissions, see the
4125 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
4126 # a list of the available pre-defined roles, see
4127 # [here](https://cloud.google.com/iam/docs/understanding-roles).
4128 },
4129 ],
4130 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
4131 # prevent simultaneous updates of a policy from overwriting each other.
4132 # It is strongly suggested that systems make use of the `etag` in the
4133 # read-modify-write cycle to perform policy updates in order to avoid race
4134 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
4135 # systems are expected to put that etag in the request to `setIamPolicy` to
4136 # ensure that their change will be applied to the same version of the policy.
4137 #
4138 # **Important:** If you use IAM Conditions, you must include the `etag` field
4139 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
4140 # you to overwrite a version `3` policy with a version `1` policy, and all of
4141 # the conditions in the version `3` policy are lost.
4142 &quot;version&quot;: 42, # Specifies the format of the policy.
4143 #
4144 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
4145 # are rejected.
4146 #
4147 # Any operation that affects conditional role bindings must specify version
4148 # `3`. This requirement applies to the following operations:
4149 #
4150 # * Getting a policy that includes a conditional role binding
4151 # * Adding a conditional role binding to a policy
4152 # * Changing a conditional role binding in a policy
4153 # * Removing any role binding, with or without a condition, from a policy
4154 # that includes conditions
4155 #
4156 # **Important:** If you use IAM Conditions, you must include the `etag` field
4157 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
4158 # you to overwrite a version `3` policy with a version `1` policy, and all of
4159 # the conditions in the version `3` policy are lost.
4160 #
4161 # If a policy does not include any conditions, operations on that policy may
4162 # specify any valid version or leave the field unset.
4163 #
4164 # To learn which resources support conditions in their IAM policies, see the
4165 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
4166 },
4167 }
4168
4169 x__xgafv: string, V1 error format.
4170 Allowed values
4171 1 - v1 error format
4172 2 - v2 error format
4173
4174 Returns:
4175 An object of the form:
4176
4177 { # An Identity and Access Management (IAM) policy, which specifies access
4178 # controls for Google Cloud resources.
4179 #
4180 #
4181 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
4182 # `members`, or principals, to a single `role`. Principals can be user
4183 # accounts, service accounts, Google groups, and domains (such as G Suite). A
4184 # `role` is a named list of permissions; each `role` can be an IAM predefined
4185 # role or a user-created custom role.
4186 #
4187 # For some types of Google Cloud resources, a `binding` can also specify a
4188 # `condition`, which is a logical expression that allows access to a resource
4189 # only if the expression evaluates to `true`. A condition can add constraints
4190 # based on attributes of the request, the resource, or both. To learn which
4191 # resources support conditions in their IAM policies, see the
4192 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
4193 #
4194 # **JSON example:**
4195 #
4196 # ```
4197 # {
4198 # &quot;bindings&quot;: [
4199 # {
4200 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
4201 # &quot;members&quot;: [
4202 # &quot;user:[email protected]&quot;,
4203 # &quot;group:[email protected]&quot;,
4204 # &quot;domain:google.com&quot;,
4205 # &quot;serviceAccount:[email protected]&quot;
4206 # ]
4207 # },
4208 # {
4209 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
4210 # &quot;members&quot;: [
4211 # &quot;user:[email protected]&quot;
4212 # ],
4213 # &quot;condition&quot;: {
4214 # &quot;title&quot;: &quot;expirable access&quot;,
4215 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
4216 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
4217 # }
4218 # }
4219 # ],
4220 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
4221 # &quot;version&quot;: 3
4222 # }
4223 # ```
4224 #
4225 # **YAML example:**
4226 #
4227 # ```
4228 # bindings:
4229 # - members:
4230 # - user:[email protected]
4231 # - group:[email protected]
4232 # - domain:google.com
4233 # - serviceAccount:[email protected]
4234 # role: roles/resourcemanager.organizationAdmin
4235 # - members:
4236 # - user:[email protected]
4237 # role: roles/resourcemanager.organizationViewer
4238 # condition:
4239 # title: expirable access
4240 # description: Does not grant access after Sep 2020
4241 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
4242 # etag: BwWWja0YfJA=
4243 # version: 3
4244 # ```
4245 #
4246 # For a description of IAM and its features, see the
4247 # [IAM documentation](https://cloud.google.com/iam/docs/).
4248 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
4249 { # Specifies the audit configuration for a service.
4250 # The configuration determines which permission types are logged, and what
4251 # identities, if any, are exempted from logging.
4252 # An AuditConfig must have one or more AuditLogConfigs.
4253 #
4254 # If there are AuditConfigs for both `allServices` and a specific service,
4255 # the union of the two AuditConfigs is used for that service: the log_types
4256 # specified in each AuditConfig are enabled, and the exempted_members in each
4257 # AuditLogConfig are exempted.
4258 #
4259 # Example Policy with multiple AuditConfigs:
4260 #
4261 # {
4262 # &quot;audit_configs&quot;: [
4263 # {
4264 # &quot;service&quot;: &quot;allServices&quot;,
4265 # &quot;audit_log_configs&quot;: [
4266 # {
4267 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
4268 # &quot;exempted_members&quot;: [
4269 # &quot;user:[email protected]&quot;
4270 # ]
4271 # },
4272 # {
4273 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
4274 # },
4275 # {
4276 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
4277 # }
4278 # ]
4279 # },
4280 # {
4281 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
4282 # &quot;audit_log_configs&quot;: [
4283 # {
4284 # &quot;log_type&quot;: &quot;DATA_READ&quot;
4285 # },
4286 # {
4287 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
4288 # &quot;exempted_members&quot;: [
4289 # &quot;user:[email protected]&quot;
4290 # ]
4291 # }
4292 # ]
4293 # }
4294 # ]
4295 # }
4296 #
4297 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
4298 # logging. It also exempts `[email protected]` from DATA_READ logging, and
4299 # `[email protected]` from DATA_WRITE logging.
4300 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
4301 { # Provides the configuration for logging a type of permissions.
4302 # Example:
4303 #
4304 # {
4305 # &quot;audit_log_configs&quot;: [
4306 # {
4307 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
4308 # &quot;exempted_members&quot;: [
4309 # &quot;user:[email protected]&quot;
4310 # ]
4311 # },
4312 # {
4313 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
4314 # }
4315 # ]
4316 # }
4317 #
4318 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
4319 # [email protected] from DATA_READ logging.
4320 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
4321 # permission.
4322 # Follows the same format of Binding.members.
4323 &quot;A String&quot;,
4324 ],
4325 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
4326 },
4327 ],
4328 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
4329 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
4330 # `allServices` is a special value that covers all services.
4331 },
4332 ],
4333 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
4334 # may specify a `condition` that determines how and when the `bindings` are
4335 # applied. Each of the `bindings` must contain at least one principal.
4336 #
4337 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
4338 # of these principals can be Google groups. Each occurrence of a principal
4339 # counts towards these limits. For example, if the `bindings` grant 50
4340 # different roles to `user:[email protected]`, and not to any other
4341 # principal, then you can add another 1,450 principals to the `bindings` in
4342 # the `Policy`.
4343 { # Associates `members`, or principals, with a `role`.
4344 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
4345 #
4346 # If the condition evaluates to `true`, then this binding applies to the
4347 # current request.
4348 #
4349 # If the condition evaluates to `false`, then this binding does not apply to
4350 # the current request. However, a different role binding might grant the same
4351 # role to one or more of the principals in this binding.
4352 #
4353 # To learn which resources support conditions in their IAM policies, see the
4354 # [IAM
4355 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
4356 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
4357 # are documented at https://github.com/google/cel-spec.
4358 #
4359 # Example (Comparison):
4360 #
4361 # title: &quot;Summary size limit&quot;
4362 # description: &quot;Determines if a summary is less than 100 chars&quot;
4363 # expression: &quot;document.summary.size() &lt; 100&quot;
4364 #
4365 # Example (Equality):
4366 #
4367 # title: &quot;Requestor is owner&quot;
4368 # description: &quot;Determines if requestor is the document owner&quot;
4369 # expression: &quot;document.owner == request.auth.claims.email&quot;
4370 #
4371 # Example (Logic):
4372 #
4373 # title: &quot;Public documents&quot;
4374 # description: &quot;Determine whether the document should be publicly visible&quot;
4375 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
4376 #
4377 # Example (Data Manipulation):
4378 #
4379 # title: &quot;Notification string&quot;
4380 # description: &quot;Create a notification string with a timestamp.&quot;
4381 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
4382 #
4383 # The exact variables and functions that may be referenced within an expression
4384 # are determined by the service that evaluates it. See the service
4385 # documentation for additional information.
4386 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
4387 # describes the expression, e.g. when hovered over it in a UI.
4388 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
4389 # syntax.
4390 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
4391 # reporting, e.g. a file name and a position in the file.
4392 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
4393 # its purpose. This can be used e.g. in UIs which allow to enter the
4394 # expression.
4395 },
4396 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
4397 # `members` can have the following values:
4398 #
4399 # * `allUsers`: A special identifier that represents anyone who is
4400 # on the internet; with or without a Google account.
4401 #
4402 # * `allAuthenticatedUsers`: A special identifier that represents anyone
4403 # who is authenticated with a Google account or a service account.
4404 # Does not include identities that come from external identity providers
4405 # (IdPs) through identity federation.
4406 #
4407 # * `user:{emailid}`: An email address that represents a specific Google
4408 # account. For example, `[email protected]` .
4409 #
4410 #
4411 # * `serviceAccount:{emailid}`: An email address that represents a Google
4412 # service account. For example,
4413 # `[email protected]`.
4414 #
4415 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
4416 # identifier for a
4417 # [Kubernetes service
4418 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
4419 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
4420 #
4421 # * `group:{emailid}`: An email address that represents a Google group.
4422 # For example, `[email protected]`.
4423 #
4424 #
4425 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
4426 # users of that domain. For example, `google.com` or `example.com`.
4427 #
4428 #
4429 #
4430 #
4431 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
4432 # A single identity in a workforce identity pool.
4433 #
4434 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
4435 # All workforce identities in a group.
4436 #
4437 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
4438 # All workforce identities with a specific attribute value.
4439 #
4440 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
4441 # All identities in a workforce identity pool.
4442 #
4443 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
4444 # A single identity in a workload identity pool.
4445 #
4446 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
4447 # A workload identity pool group.
4448 #
4449 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
4450 # All identities in a workload identity pool with a certain attribute.
4451 #
4452 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
4453 # All identities in a workload identity pool.
4454 #
4455 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
4456 # identifier) representing a user that has been recently deleted. For
4457 # example, `[email protected]?uid=123456789012345678901`. If the user is
4458 # recovered, this value reverts to `user:{emailid}` and the recovered user
4459 # retains the role in the binding.
4460 #
4461 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
4462 # unique identifier) representing a service account that has been recently
4463 # deleted. For example,
4464 # `[email protected]?uid=123456789012345678901`.
4465 # If the service account is undeleted, this value reverts to
4466 # `serviceAccount:{emailid}` and the undeleted service account retains the
4467 # role in the binding.
4468 #
4469 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
4470 # identifier) representing a Google group that has been recently
4471 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
4472 # the group is recovered, this value reverts to `group:{emailid}` and the
4473 # recovered group retains the role in the binding.
4474 #
4475 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
4476 # Deleted single identity in a workforce identity pool. For example,
4477 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
4478 &quot;A String&quot;,
4479 ],
4480 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
4481 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
4482 #
4483 # For an overview of the IAM roles and permissions, see the
4484 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
4485 # a list of the available pre-defined roles, see
4486 # [here](https://cloud.google.com/iam/docs/understanding-roles).
4487 },
4488 ],
4489 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
4490 # prevent simultaneous updates of a policy from overwriting each other.
4491 # It is strongly suggested that systems make use of the `etag` in the
4492 # read-modify-write cycle to perform policy updates in order to avoid race
4493 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
4494 # systems are expected to put that etag in the request to `setIamPolicy` to
4495 # ensure that their change will be applied to the same version of the policy.
4496 #
4497 # **Important:** If you use IAM Conditions, you must include the `etag` field
4498 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
4499 # you to overwrite a version `3` policy with a version `1` policy, and all of
4500 # the conditions in the version `3` policy are lost.
4501 &quot;version&quot;: 42, # Specifies the format of the policy.
4502 #
4503 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
4504 # are rejected.
4505 #
4506 # Any operation that affects conditional role bindings must specify version
4507 # `3`. This requirement applies to the following operations:
4508 #
4509 # * Getting a policy that includes a conditional role binding
4510 # * Adding a conditional role binding to a policy
4511 # * Changing a conditional role binding in a policy
4512 # * Removing any role binding, with or without a condition, from a policy
4513 # that includes conditions
4514 #
4515 # **Important:** If you use IAM Conditions, you must include the `etag` field
4516 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
4517 # you to overwrite a version `3` policy with a version `1` policy, and all of
4518 # the conditions in the version `3` policy are lost.
4519 #
4520 # If a policy does not include any conditions, operations on that policy may
4521 # specify any valid version or leave the field unset.
4522 #
4523 # To learn which resources support conditions in their IAM policies, see the
4524 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
4525 }</pre>
4526 </div>
4527
4528 <div class="method">
4529 <code class="details" id="setLabels">setLabels(project, region, resource, body=None, requestId=None, x__xgafv=None)</code>
4530 <pre>Sets the labels on an InterconnectAttachment. To learn more about labels,
4531 read the Labeling
4532 Resources documentation.
4533
4534 Args:
4535 project: string, Project ID for this request. (required)
4536 region: string, The region for this request. (required)
4537 resource: string, Name or id of the resource for this request. (required)
4538 body: object, The request body.
4539 The object takes the form of:
4540
4541 {
4542 &quot;labelFingerprint&quot;: &quot;A String&quot;, # The fingerprint of the previous set of labels for this resource,
4543 # used to detect conflicts. The fingerprint is initially generated by Compute
4544 # Engine and changes after every request to modify or update labels. You must
4545 # always provide an up-to-date fingerprint hash in order to update or change
4546 # labels. Make a get() request to the resource to get the latest
4547 # fingerprint.
4548 &quot;labels&quot;: { # The labels to set for this resource.
4549 &quot;a_key&quot;: &quot;A String&quot;,
4550 },
4551 }
4552
4553 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
4554 that if you must retry your request, the server will know to ignore the
4555 request if it has already been completed.
4556
4557 For example, consider a situation where you make an initial request and
4558 the request times out. If you make the request again with the same
4559 request ID, the server can check if original operation with the same
4560 request ID was received, and if so, will ignore the second request. This
4561 prevents clients from accidentally creating duplicate commitments.
4562
4563 The request ID must be
4564 a valid UUID with the exception that zero UUID is not supported
4565 (00000000-0000-0000-0000-000000000000).
4566 x__xgafv: string, V1 error format.
4567 Allowed values
4568 1 - v1 error format
4569 2 - v2 error format
4570
4571 Returns:
4572 An object of the form:
4573
4574 { # Represents an Operation resource.
4575 #
4576 # Google Compute Engine has three Operation resources:
4577 #
4578 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
4579 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
4580 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
4581 #
4582 # You can use an operation resource to manage asynchronous API requests.
4583 # For more information, readHandling
4584 # API responses.
4585 #
4586 # Operations can be global, regional or zonal.
4587 #
4588 # - For global operations, use the `globalOperations`
4589 # resource.
4590 # - For regional operations, use the
4591 # `regionOperations` resource.
4592 # - For zonal operations, use
4593 # the `zoneOperations` resource.
4594 #
4595 #
4596 #
4597 # For more information, read
4598 # Global, Regional, and Zonal Resources.
4599 #
4600 # Note that completed Operation resources have a limited
4601 # retention period.
4602 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
4603 # Not present otherwise.
4604 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4605 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
4606 # set when the operation is created.
4607 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
4608 # text format.
4609 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
4610 # this field will be populated.
4611 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
4612 # operation.
4613 {
4614 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4615 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
4616 # details. There is a set of defined message types to use for providing
4617 # details.The syntax depends on the error code. For example,
4618 # QuotaExceededInfo will have details when the error code is
4619 # QUOTA_EXCEEDED.
4620 {
4621 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
4622 #
4623 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
4624 # is not enabled:
4625 #
4626 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
4627 # &quot;domain&quot;: &quot;googleapis.com&quot;
4628 # &quot;metadata&quot;: {
4629 # &quot;resource&quot;: &quot;projects/123&quot;,
4630 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
4631 # }
4632 # }
4633 #
4634 # This response indicates that the pubsub.googleapis.com API is not enabled.
4635 #
4636 # Example of an error that is returned when attempting to create a Spanner
4637 # instance in a region that is out of stock:
4638 #
4639 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
4640 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
4641 # &quot;metadata&quot;: {
4642 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
4643 # }
4644 # }
4645 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
4646 # is typically the registered service name of the tool or product that
4647 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
4648 # generated by some common infrastructure, the error domain must be a
4649 # globally unique value that identifies the infrastructure. For Google API
4650 # infrastructure, the error domain is &quot;googleapis.com&quot;.
4651 &quot;metadatas&quot;: { # Additional structured details about this error.
4652 #
4653 # Keys must match a regular expression of `a-z+` but should
4654 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
4655 # length. When identifying the current value of an exceeded limit, the units
4656 # should be contained in the key, not the value. For example, rather than
4657 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
4658 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
4659 # instances that can be created in a single (batch) request.
4660 &quot;a_key&quot;: &quot;A String&quot;,
4661 },
4662 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
4663 # proximate cause of the error. Error reasons are unique within a particular
4664 # domain of errors. This should be at most 63 characters and match a
4665 # regular expression of `A-Z+[A-Z0-9]`, which represents
4666 # UPPER_SNAKE_CASE.
4667 },
4668 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
4669 #
4670 # For example, if a quota check failed with an error indicating the calling
4671 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
4672 # directly to the right place in the developer console to flip the bit.
4673 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
4674 { # Describes a URL link.
4675 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
4676 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
4677 },
4678 ],
4679 },
4680 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
4681 # which can be attached to an RPC error.
4682 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
4683 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
4684 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
4685 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
4686 },
4687 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
4688 &quot;dimensions&quot;: { # The map holding related quota dimensions.
4689 &quot;a_key&quot;: &quot;A String&quot;,
4690 },
4691 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
4692 # type or metric.
4693 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
4694 # or metric.
4695 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
4696 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
4697 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
4698 },
4699 },
4700 ],
4701 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
4702 # This property is optional.
4703 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
4704 },
4705 ],
4706 },
4707 &quot;getVersionOperationMetadata&quot;: {
4708 &quot;inlineSbomInfo&quot;: {
4709 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
4710 # appropriate identifiers.
4711 &quot;a_key&quot;: &quot;A String&quot;,
4712 },
4713 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
4714 # identifiers.
4715 &quot;a_key&quot;: &quot;A String&quot;,
4716 },
4717 },
4718 },
4719 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
4720 # message that was returned, such as `NOT FOUND`.
4721 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
4722 # status code that was returned. For example, a `404` means the
4723 # resource was not found.
4724 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
4725 # defined by the server.
4726 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
4727 # This value is inRFC3339
4728 # text format.
4729 &quot;instancesBulkInsertOperationMetadata&quot;: {
4730 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
4731 # Example key: zones/us-central1-a
4732 &quot;a_key&quot;: {
4733 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
4734 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
4735 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
4736 # error.
4737 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
4738 # if the flow is rolling forward or rolling back.
4739 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
4740 },
4741 },
4742 },
4743 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
4744 # Operation resources.
4745 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
4746 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
4747 # group of operations results from a `bulkInsert` API request.
4748 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
4749 # `update`, or `delete`, and so on.
4750 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
4751 # There is no requirement that this be linear or support any granularity of
4752 # operations. This should not be used to guess when the operation will be
4753 # complete. This number should monotonically increase as the operation
4754 # progresses.
4755 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
4756 # applicable when performing regional operations.
4757 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4758 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
4759 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
4760 # this field will contain information on all underlying zonal actions and
4761 # their state.
4762 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
4763 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
4764 # Example key: zones/us-central1-a
4765 &quot;a_key&quot;: {
4766 &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
4767 # populated.
4768 # different programming environments, including REST APIs and RPC APIs. It is
4769 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
4770 # three pieces of data: error code, error message, and error details.
4771 #
4772 # You can find out more about this error model and how to work with it in the
4773 # [API Design Guide](https://cloud.google.com/apis/design/errors).
4774 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
4775 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
4776 # message types for APIs to use.
4777 {
4778 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
4779 },
4780 ],
4781 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
4782 # user-facing error message should be localized and sent in the
4783 # google.rpc.Status.details field, or localized by the client.
4784 },
4785 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
4786 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
4787 },
4788 },
4789 },
4790 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
4791 # This value is inRFC3339
4792 # text format.
4793 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
4794 # following:
4795 # `PENDING`, `RUNNING`, or `DONE`.
4796 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
4797 # operation.
4798 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
4799 # of the target resource.
4800 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
4801 # operations related to creating a snapshot, this points to the disk
4802 # that the snapshot was created from.
4803 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
4804 # `[email protected]` or
4805 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
4806 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
4807 # operation, this field will be populated.
4808 {
4809 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4810 # Engine returns NO_RESULTS_ON_PAGE if there
4811 # are no results in the response.
4812 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4813 # value format. For example:
4814 #
4815 # &quot;data&quot;: [
4816 # {
4817 # &quot;key&quot;: &quot;scope&quot;,
4818 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4819 # }
4820 {
4821 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4822 # returned. For example, for warnings where there are no results in a list
4823 # request for a particular zone, this key might be scope and
4824 # the key value might be the zone name. Other examples might be a key
4825 # indicating a deprecated resource and a suggested replacement, or a
4826 # warning about invalid network settings (for example, if an instance
4827 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4828 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4829 },
4830 ],
4831 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4832 },
4833 ],
4834 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
4835 # applicable when performing per-zone operations.
4836 }</pre>
4837 </div>
4838
4839 <div class="method">
4840 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code>
4841 <pre>Returns permissions that a caller has on the specified resource.
4842
4843 Args:
4844 project: string, Project ID for this request. (required)
4845 region: string, The name of the region for this request. (required)
4846 resource: string, Name or id of the resource for this request. (required)
4847 body: object, The request body.
4848 The object takes the form of:
4849
4850 {
4851 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
4852 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
4853 &quot;A String&quot;,
4854 ],
4855 }
4856
4857 x__xgafv: string, V1 error format.
4858 Allowed values
4859 1 - v1 error format
4860 2 - v2 error format
4861
4862 Returns:
4863 An object of the form:
4864
4865 {
4866 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
4867 # allowed.
4868 &quot;A String&quot;,
4869 ],
4870 }</pre>
4871 </div>
4872
4873 </body></html>