Debian Codegraph @

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