Debian Codegraph @

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