blob: 113bcfb8b1cc804666218a8535658b181da6c732 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070079<p class="firstline">Retrieves an aggregated list of interconnect attachments.</p>
80<p class="toc_element">
81 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070084 <code><a href="#close">close()</a></code></p>
85<p class="firstline">Close httplib2 connections.</p>
86<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070087 <code><a href="#delete">delete(project, region, interconnectAttachment, requestId=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)</a></code></p>
91<p class="firstline">Returns the specified interconnect attachment.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070093 <code><a href="#insert">insert(project, region, body=None, requestId=None, validateOnly=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070094<p class="firstline">Creates an InterconnectAttachment in the specified project using the data included in the request.</p>
95<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070096 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070097<p class="firstline">Retrieves the list of interconnect attachments contained within the specified region.</p>
98<p class="toc_element">
99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700102 <code><a href="#patch">patch(project, region, interconnectAttachment, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700103<p class="firstline">Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>
104<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700105 <code><a href="#setLabels">setLabels(project, region, resource, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700106<p class="firstline">Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation.</p>
107<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700108 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700109<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
110<h3>Method Details</h3>
111<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700112 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700113 <pre>Retrieves an aggregated list of interconnect attachments.
114
115Args:
116 project: string, Project ID for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700117 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700118
Dan O'Mearadd494642020-05-01 07:42:23 -0700119For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700120
Dan O'Mearadd494642020-05-01 07:42:23 -0700121You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700122
Bu Sun Kim65020912020-05-20 12:08:20 -0700123To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &quot;Intel Skylake&quot;) ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = &quot;Intel Skylake&quot;) OR (cpuPlatform = &quot;Intel Broadwell&quot;) AND (scheduling.automaticRestart = true) ```
Dan O'Mearadd494642020-05-01 07:42:23 -0700124 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Bu Sun Kim65020912020-05-20 12:08:20 -0700125 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
126 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
127
128You can also sort results in descending order based on the creation timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
129
130Currently, only sorting by `name` or `creationTimestamp desc` is supported.
131 pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800132 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700133
134Returns:
135 An object of the form:
136
137 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800138 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
139 &quot;items&quot;: { # A list of InterconnectAttachmentsScopedList resources.
140 &quot;a_key&quot;: { # Name of the scope containing this set of interconnect attachments.
141 &quot;interconnectAttachments&quot;: [ # A list of interconnect attachments contained in this scope.
142 { # Represents an Interconnect Attachment (VLAN) resource.
143 #
144 # You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. (== resource_for {$api_version}.interconnectAttachments ==)
145 &quot;adminEnabled&quot;: True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
146 &quot;bandwidth&quot;: &quot;A String&quot;, # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values:
147 # - BPS_50M: 50 Mbit/s
148 # - BPS_100M: 100 Mbit/s
149 # - BPS_200M: 200 Mbit/s
150 # - BPS_300M: 300 Mbit/s
151 # - BPS_400M: 400 Mbit/s
152 # - BPS_500M: 500 Mbit/s
153 # - BPS_1G: 1 Gbit/s
154 # - BPS_2G: 2 Gbit/s
155 # - BPS_5G: 5 Gbit/s
156 # - BPS_10G: 10 Gbit/s
157 # - BPS_20G: 20 Gbit/s
158 # - BPS_50G: 50 Gbit/s
159 &quot;candidateSubnets&quot;: [ # Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google&#x27;s edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.
160 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700161 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800162 &quot;cloudRouterIpAddress&quot;: &quot;A String&quot;, # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
163 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
164 &quot;customerRouterIpAddress&quot;: &quot;A String&quot;, # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
165 &quot;dataplaneVersion&quot;: 42, # [Output Only] Dataplane version for this InterconnectAttachment.
166 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource.
167 &quot;edgeAvailabilityDomain&quot;: &quot;A String&quot;, # Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values:
168 # - AVAILABILITY_DOMAIN_ANY
169 # - AVAILABILITY_DOMAIN_1
170 # - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700171 &quot;encryption&quot;: &quot;A String&quot;, # Indicates the user-supplied encryption option of this interconnect attachment:
172 # - NONE is the default value, which means that the attachment carries unencrypted traffic. VMs can send traffic to, or receive traffic from, this type of attachment.
173 # - IPSEC indicates that the attachment carries only traffic encrypted by an IPsec device such as an HA VPN gateway. VMs cannot directly send traffic to, or receive traffic from, such an attachment. To use IPsec-encrypted Cloud Interconnect, create the attachment using this option.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400174 # Not currently available in all Interconnect locations.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800175 &quot;googleReferenceId&quot;: &quot;A String&quot;, # [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used.
176 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
177 &quot;interconnect&quot;: &quot;A String&quot;, # URL of the underlying Interconnect object that this attachment&#x27;s traffic will traverse through.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700178 &quot;ipsecInternalAddresses&quot;: [ # URL of addresses that have been reserved for the interconnect attachment, Used only for interconnect attachment that has the encryption option as IPSEC. The addresses must be RFC 1918 IP address ranges. When creating HA VPN gateway over the interconnect attachment, if the attachment is configured to use an RFC 1918 IP address, then the VPN gateway?s IP address will be allocated from the IP address range specified here. For example, if the HA VPN gateway?s interface 0 is paired to this interconnect attachment, then an RFC 1918 IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this interconnect attachment. If this field is not specified for interconnect attachment that has encryption option as IPSEC, later on when creating HA VPN gateway on this interconnect attachment, the HA VPN gateway&#x27;s IP address will be allocated from regional external IP address pool.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400179 # Not currently available in all Interconnect locations.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700180 &quot;A String&quot;,
181 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800182 &quot;kind&quot;: &quot;compute#interconnectAttachment&quot;, # [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.
183 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.
184 #
185 # To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment.
186 &quot;labels&quot;: { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
187 &quot;a_key&quot;: &quot;A String&quot;,
188 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800189 &quot;mtu&quot;: 42, # Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800190 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
191 &quot;operationalStatus&quot;: &quot;A String&quot;, # [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values:
192 # - OS_ACTIVE: The attachment has been turned up and is ready to use.
193 # - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
194 &quot;pairingKey&quot;: &quot;A String&quot;, # [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form &quot;XXXXX/region/domain&quot;
195 &quot;partnerAsn&quot;: &quot;A String&quot;, # Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.
196 &quot;partnerMetadata&quot;: { # Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments. # Informational metadata about Partner attachments from Partners to display to customers. Output only for for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.
197 &quot;interconnectName&quot;: &quot;A String&quot;, # Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner&#x27;s portal. For instance &quot;Chicago 1&quot;. This value may be validated to match approved Partner values.
198 &quot;partnerName&quot;: &quot;A String&quot;, # Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.
199 &quot;portalUrl&quot;: &quot;A String&quot;, # URL of the Partner&#x27;s portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values.
200 },
201 &quot;privateInterconnectInfo&quot;: { # Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED. # [Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.
202 &quot;tag8021q&quot;: 42, # [Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region.
203 },
204 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
205 &quot;router&quot;: &quot;A String&quot;, # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network &amp; region within which the Cloud Router is configured.
206 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
207 &quot;state&quot;: &quot;A String&quot;, # [Output Only] The current state of this attachment&#x27;s functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values:
208 # - ACTIVE: The attachment has been turned up and is ready to use.
209 # - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
210 # - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side.
211 # - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.
212 # - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it.
213 # - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted.
214 &quot;type&quot;: &quot;A String&quot;, # The type of interconnect attachment this is, which can take one of the following values:
215 # - DEDICATED: an attachment to a Dedicated Interconnect.
216 # - PARTNER: an attachment to a Partner Interconnect, created by the customer.
217 # - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.
218 &quot;vlanTag8021q&quot;: 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700219 },
220 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800221 &quot;warning&quot;: { # Informational warning which replaces the list of addresses when the list is empty.
222 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
223 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
224 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
225 {
226 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
227 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
228 },
229 ],
230 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
231 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700232 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800233 },
234 &quot;kind&quot;: &quot;compute#interconnectAttachmentAggregatedList&quot;, # [Output Only] Type of resource. Always compute#interconnectAttachmentAggregatedList for aggregated lists of interconnect attachments.
235 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
236 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
237 &quot;unreachables&quot;: [ # [Output Only] Unreachable resources.
238 &quot;A String&quot;,
239 ],
240 &quot;warning&quot;: { # [Output Only] Informational warning message.
241 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
242 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
243 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
244 {
245 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
246 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
247 },
248 ],
249 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
250 },
251}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700252</div>
253
254<div class="method">
255 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
256 <pre>Retrieves the next page of results.
257
258Args:
259 previous_request: The request for the previous page. (required)
260 previous_response: The response from the request for the previous page. (required)
261
262Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700263 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700264 page. Returns None if there are no more items in the collection.
265 </pre>
266</div>
267
268<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700269 <code class="details" id="close">close()</code>
270 <pre>Close httplib2 connections.</pre>
271</div>
272
273<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700274 <code class="details" id="delete">delete(project, region, interconnectAttachment, requestId=None)</code>
275 <pre>Deletes the specified interconnect attachment.
276
277Args:
278 project: string, Project ID for this request. (required)
279 region: string, Name of the region for this request. (required)
280 interconnectAttachment: string, Name of the interconnect attachment to delete. (required)
281 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
282
283For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
284
285The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
286
287Returns:
288 An object of the form:
289
290 { # Represents an Operation resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800291 #
292 # Google Compute Engine has three Operation resources:
293 #
294 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
295 #
296 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
297 #
298 # Operations can be global, regional or zonal.
299 # - For global operations, use the `globalOperations` resource.
300 # - For regional operations, use the `regionOperations` resource.
301 # - For zonal operations, use the `zonalOperations` resource.
302 #
303 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
304 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
305 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
306 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
307 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
308 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
309 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700310 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800311 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
312 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
313 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700314 },
315 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800316 },
317 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
318 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
319 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
320 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
321 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
322 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800323 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800324 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
325 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
326 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
327 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
328 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
329 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
330 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
331 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
332 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
333 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
334 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
335 {
336 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
337 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
338 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
339 {
340 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
341 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
342 },
343 ],
344 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
345 },
346 ],
347 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
348}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700349</div>
350
351<div class="method">
352 <code class="details" id="get">get(project, region, interconnectAttachment)</code>
353 <pre>Returns the specified interconnect attachment.
354
355Args:
356 project: string, Project ID for this request. (required)
357 region: string, Name of the region for this request. (required)
358 interconnectAttachment: string, Name of the interconnect attachment to return. (required)
359
360Returns:
361 An object of the form:
362
363 { # Represents an Interconnect Attachment (VLAN) resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800364 #
365 # You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. (== resource_for {$api_version}.interconnectAttachments ==)
366 &quot;adminEnabled&quot;: True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
367 &quot;bandwidth&quot;: &quot;A String&quot;, # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values:
368 # - BPS_50M: 50 Mbit/s
369 # - BPS_100M: 100 Mbit/s
370 # - BPS_200M: 200 Mbit/s
371 # - BPS_300M: 300 Mbit/s
372 # - BPS_400M: 400 Mbit/s
373 # - BPS_500M: 500 Mbit/s
374 # - BPS_1G: 1 Gbit/s
375 # - BPS_2G: 2 Gbit/s
376 # - BPS_5G: 5 Gbit/s
377 # - BPS_10G: 10 Gbit/s
378 # - BPS_20G: 20 Gbit/s
379 # - BPS_50G: 50 Gbit/s
380 &quot;candidateSubnets&quot;: [ # Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google&#x27;s edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.
381 &quot;A String&quot;,
382 ],
383 &quot;cloudRouterIpAddress&quot;: &quot;A String&quot;, # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
384 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
385 &quot;customerRouterIpAddress&quot;: &quot;A String&quot;, # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
386 &quot;dataplaneVersion&quot;: 42, # [Output Only] Dataplane version for this InterconnectAttachment.
387 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource.
388 &quot;edgeAvailabilityDomain&quot;: &quot;A String&quot;, # Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values:
389 # - AVAILABILITY_DOMAIN_ANY
390 # - AVAILABILITY_DOMAIN_1
391 # - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700392 &quot;encryption&quot;: &quot;A String&quot;, # Indicates the user-supplied encryption option of this interconnect attachment:
393 # - NONE is the default value, which means that the attachment carries unencrypted traffic. VMs can send traffic to, or receive traffic from, this type of attachment.
394 # - IPSEC indicates that the attachment carries only traffic encrypted by an IPsec device such as an HA VPN gateway. VMs cannot directly send traffic to, or receive traffic from, such an attachment. To use IPsec-encrypted Cloud Interconnect, create the attachment using this option.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400395 # Not currently available in all Interconnect locations.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800396 &quot;googleReferenceId&quot;: &quot;A String&quot;, # [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used.
397 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
398 &quot;interconnect&quot;: &quot;A String&quot;, # URL of the underlying Interconnect object that this attachment&#x27;s traffic will traverse through.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700399 &quot;ipsecInternalAddresses&quot;: [ # URL of addresses that have been reserved for the interconnect attachment, Used only for interconnect attachment that has the encryption option as IPSEC. The addresses must be RFC 1918 IP address ranges. When creating HA VPN gateway over the interconnect attachment, if the attachment is configured to use an RFC 1918 IP address, then the VPN gateway?s IP address will be allocated from the IP address range specified here. For example, if the HA VPN gateway?s interface 0 is paired to this interconnect attachment, then an RFC 1918 IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this interconnect attachment. If this field is not specified for interconnect attachment that has encryption option as IPSEC, later on when creating HA VPN gateway on this interconnect attachment, the HA VPN gateway&#x27;s IP address will be allocated from regional external IP address pool.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400400 # Not currently available in all Interconnect locations.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700401 &quot;A String&quot;,
402 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800403 &quot;kind&quot;: &quot;compute#interconnectAttachment&quot;, # [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.
404 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.
Bu Sun Kim65020912020-05-20 12:08:20 -0700405 #
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800406 # To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment.
407 &quot;labels&quot;: { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
408 &quot;a_key&quot;: &quot;A String&quot;,
409 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800410 &quot;mtu&quot;: 42, # Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800411 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
412 &quot;operationalStatus&quot;: &quot;A String&quot;, # [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values:
413 # - OS_ACTIVE: The attachment has been turned up and is ready to use.
414 # - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
415 &quot;pairingKey&quot;: &quot;A String&quot;, # [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form &quot;XXXXX/region/domain&quot;
416 &quot;partnerAsn&quot;: &quot;A String&quot;, # Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.
417 &quot;partnerMetadata&quot;: { # Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments. # Informational metadata about Partner attachments from Partners to display to customers. Output only for for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.
418 &quot;interconnectName&quot;: &quot;A String&quot;, # Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner&#x27;s portal. For instance &quot;Chicago 1&quot;. This value may be validated to match approved Partner values.
419 &quot;partnerName&quot;: &quot;A String&quot;, # Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.
420 &quot;portalUrl&quot;: &quot;A String&quot;, # URL of the Partner&#x27;s portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values.
421 },
422 &quot;privateInterconnectInfo&quot;: { # Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED. # [Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.
423 &quot;tag8021q&quot;: 42, # [Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region.
424 },
425 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
426 &quot;router&quot;: &quot;A String&quot;, # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network &amp; region within which the Cloud Router is configured.
427 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
428 &quot;state&quot;: &quot;A String&quot;, # [Output Only] The current state of this attachment&#x27;s functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values:
429 # - ACTIVE: The attachment has been turned up and is ready to use.
430 # - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
431 # - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side.
432 # - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.
433 # - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it.
434 # - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted.
435 &quot;type&quot;: &quot;A String&quot;, # The type of interconnect attachment this is, which can take one of the following values:
436 # - DEDICATED: an attachment to a Dedicated Interconnect.
437 # - PARTNER: an attachment to a Partner Interconnect, created by the customer.
438 # - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.
439 &quot;vlanTag8021q&quot;: 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.
440}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700441</div>
442
443<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700444 <code class="details" id="insert">insert(project, region, body=None, requestId=None, validateOnly=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700445 <pre>Creates an InterconnectAttachment in the specified project using the data included in the request.
446
447Args:
448 project: string, Project ID for this request. (required)
449 region: string, Name of the region for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700450 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700451 The object takes the form of:
452
453{ # Represents an Interconnect Attachment (VLAN) resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700454 #
455 # You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. (== resource_for {$api_version}.interconnectAttachments ==)
456 &quot;adminEnabled&quot;: True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
457 &quot;bandwidth&quot;: &quot;A String&quot;, # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values:
458 # - BPS_50M: 50 Mbit/s
459 # - BPS_100M: 100 Mbit/s
460 # - BPS_200M: 200 Mbit/s
461 # - BPS_300M: 300 Mbit/s
462 # - BPS_400M: 400 Mbit/s
463 # - BPS_500M: 500 Mbit/s
464 # - BPS_1G: 1 Gbit/s
465 # - BPS_2G: 2 Gbit/s
466 # - BPS_5G: 5 Gbit/s
467 # - BPS_10G: 10 Gbit/s
468 # - BPS_20G: 20 Gbit/s
469 # - BPS_50G: 50 Gbit/s
470 &quot;candidateSubnets&quot;: [ # Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google&#x27;s edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.
471 &quot;A String&quot;,
472 ],
473 &quot;cloudRouterIpAddress&quot;: &quot;A String&quot;, # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
474 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
475 &quot;customerRouterIpAddress&quot;: &quot;A String&quot;, # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800476 &quot;dataplaneVersion&quot;: 42, # [Output Only] Dataplane version for this InterconnectAttachment.
Bu Sun Kim65020912020-05-20 12:08:20 -0700477 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource.
478 &quot;edgeAvailabilityDomain&quot;: &quot;A String&quot;, # Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values:
479 # - AVAILABILITY_DOMAIN_ANY
480 # - AVAILABILITY_DOMAIN_1
481 # - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700482 &quot;encryption&quot;: &quot;A String&quot;, # Indicates the user-supplied encryption option of this interconnect attachment:
483 # - NONE is the default value, which means that the attachment carries unencrypted traffic. VMs can send traffic to, or receive traffic from, this type of attachment.
484 # - IPSEC indicates that the attachment carries only traffic encrypted by an IPsec device such as an HA VPN gateway. VMs cannot directly send traffic to, or receive traffic from, such an attachment. To use IPsec-encrypted Cloud Interconnect, create the attachment using this option.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400485 # Not currently available in all Interconnect locations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700486 &quot;googleReferenceId&quot;: &quot;A String&quot;, # [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used.
487 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
488 &quot;interconnect&quot;: &quot;A String&quot;, # URL of the underlying Interconnect object that this attachment&#x27;s traffic will traverse through.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700489 &quot;ipsecInternalAddresses&quot;: [ # URL of addresses that have been reserved for the interconnect attachment, Used only for interconnect attachment that has the encryption option as IPSEC. The addresses must be RFC 1918 IP address ranges. When creating HA VPN gateway over the interconnect attachment, if the attachment is configured to use an RFC 1918 IP address, then the VPN gateway?s IP address will be allocated from the IP address range specified here. For example, if the HA VPN gateway?s interface 0 is paired to this interconnect attachment, then an RFC 1918 IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this interconnect attachment. If this field is not specified for interconnect attachment that has encryption option as IPSEC, later on when creating HA VPN gateway on this interconnect attachment, the HA VPN gateway&#x27;s IP address will be allocated from regional external IP address pool.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400490 # Not currently available in all Interconnect locations.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700491 &quot;A String&quot;,
492 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700493 &quot;kind&quot;: &quot;compute#interconnectAttachment&quot;, # [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.
494 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700495 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700496 # To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment.
497 &quot;labels&quot;: { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
498 &quot;a_key&quot;: &quot;A String&quot;,
499 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800500 &quot;mtu&quot;: 42, # Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.
Bu Sun Kim65020912020-05-20 12:08:20 -0700501 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
502 &quot;operationalStatus&quot;: &quot;A String&quot;, # [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values:
503 # - OS_ACTIVE: The attachment has been turned up and is ready to use.
504 # - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
505 &quot;pairingKey&quot;: &quot;A String&quot;, # [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form &quot;XXXXX/region/domain&quot;
506 &quot;partnerAsn&quot;: &quot;A String&quot;, # Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.
507 &quot;partnerMetadata&quot;: { # Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments. # Informational metadata about Partner attachments from Partners to display to customers. Output only for for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.
508 &quot;interconnectName&quot;: &quot;A String&quot;, # Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner&#x27;s portal. For instance &quot;Chicago 1&quot;. This value may be validated to match approved Partner values.
509 &quot;partnerName&quot;: &quot;A String&quot;, # Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.
510 &quot;portalUrl&quot;: &quot;A String&quot;, # URL of the Partner&#x27;s portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values.
511 },
512 &quot;privateInterconnectInfo&quot;: { # Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED. # [Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.
513 &quot;tag8021q&quot;: 42, # [Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region.
514 },
515 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
516 &quot;router&quot;: &quot;A String&quot;, # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network &amp; region within which the Cloud Router is configured.
517 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
518 &quot;state&quot;: &quot;A String&quot;, # [Output Only] The current state of this attachment&#x27;s functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values:
519 # - ACTIVE: The attachment has been turned up and is ready to use.
520 # - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
521 # - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side.
522 # - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.
523 # - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it.
524 # - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted.
525 &quot;type&quot;: &quot;A String&quot;, # The type of interconnect attachment this is, which can take one of the following values:
526 # - DEDICATED: an attachment to a Dedicated Interconnect.
527 # - PARTNER: an attachment to a Partner Interconnect, created by the customer.
528 # - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.
529 &quot;vlanTag8021q&quot;: 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.
530}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700531
532 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
533
534For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
535
536The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Dan O'Mearadd494642020-05-01 07:42:23 -0700537 validateOnly: boolean, If true, the request will not be committed.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700538
539Returns:
540 An object of the form:
541
542 { # Represents an Operation resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800543 #
544 # Google Compute Engine has three Operation resources:
545 #
546 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
547 #
548 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
549 #
550 # Operations can be global, regional or zonal.
551 # - For global operations, use the `globalOperations` resource.
552 # - For regional operations, use the `regionOperations` resource.
553 # - For zonal operations, use the `zonalOperations` resource.
554 #
555 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
556 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
557 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
558 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
559 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
560 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
561 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700562 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800563 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
564 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
565 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700566 },
567 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800568 },
569 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
570 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
571 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
572 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
573 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
574 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800575 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800576 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
577 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
578 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
579 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
580 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
581 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
582 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
583 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
584 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
585 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
586 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
587 {
588 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
589 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
590 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
591 {
592 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
593 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
594 },
595 ],
596 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
597 },
598 ],
599 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
600}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700601</div>
602
603<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700604 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700605 <pre>Retrieves the list of interconnect attachments contained within the specified region.
606
607Args:
608 project: string, Project ID for this request. (required)
609 region: string, Name of the region for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700610 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700611
Dan O'Mearadd494642020-05-01 07:42:23 -0700612For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700613
Dan O'Mearadd494642020-05-01 07:42:23 -0700614You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700615
Bu Sun Kim65020912020-05-20 12:08:20 -0700616To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &quot;Intel Skylake&quot;) ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = &quot;Intel Skylake&quot;) OR (cpuPlatform = &quot;Intel Broadwell&quot;) AND (scheduling.automaticRestart = true) ```
617 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
618 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
619
620You can also sort results in descending order based on the creation timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
621
622Currently, only sorting by `name` or `creationTimestamp desc` is supported.
623 pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800624 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700625
626Returns:
627 An object of the form:
628
629 { # Response to the list request, and contains a list of interconnect attachments.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800630 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
631 &quot;items&quot;: [ # A list of InterconnectAttachment resources.
632 { # Represents an Interconnect Attachment (VLAN) resource.
633 #
634 # You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. (== resource_for {$api_version}.interconnectAttachments ==)
635 &quot;adminEnabled&quot;: True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
636 &quot;bandwidth&quot;: &quot;A String&quot;, # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values:
637 # - BPS_50M: 50 Mbit/s
638 # - BPS_100M: 100 Mbit/s
639 # - BPS_200M: 200 Mbit/s
640 # - BPS_300M: 300 Mbit/s
641 # - BPS_400M: 400 Mbit/s
642 # - BPS_500M: 500 Mbit/s
643 # - BPS_1G: 1 Gbit/s
644 # - BPS_2G: 2 Gbit/s
645 # - BPS_5G: 5 Gbit/s
646 # - BPS_10G: 10 Gbit/s
647 # - BPS_20G: 20 Gbit/s
648 # - BPS_50G: 50 Gbit/s
649 &quot;candidateSubnets&quot;: [ # Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google&#x27;s edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.
650 &quot;A String&quot;,
651 ],
652 &quot;cloudRouterIpAddress&quot;: &quot;A String&quot;, # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
653 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
654 &quot;customerRouterIpAddress&quot;: &quot;A String&quot;, # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
655 &quot;dataplaneVersion&quot;: 42, # [Output Only] Dataplane version for this InterconnectAttachment.
656 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource.
657 &quot;edgeAvailabilityDomain&quot;: &quot;A String&quot;, # Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values:
658 # - AVAILABILITY_DOMAIN_ANY
659 # - AVAILABILITY_DOMAIN_1
660 # - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700661 &quot;encryption&quot;: &quot;A String&quot;, # Indicates the user-supplied encryption option of this interconnect attachment:
662 # - NONE is the default value, which means that the attachment carries unencrypted traffic. VMs can send traffic to, or receive traffic from, this type of attachment.
663 # - IPSEC indicates that the attachment carries only traffic encrypted by an IPsec device such as an HA VPN gateway. VMs cannot directly send traffic to, or receive traffic from, such an attachment. To use IPsec-encrypted Cloud Interconnect, create the attachment using this option.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400664 # Not currently available in all Interconnect locations.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800665 &quot;googleReferenceId&quot;: &quot;A String&quot;, # [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used.
666 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
667 &quot;interconnect&quot;: &quot;A String&quot;, # URL of the underlying Interconnect object that this attachment&#x27;s traffic will traverse through.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700668 &quot;ipsecInternalAddresses&quot;: [ # URL of addresses that have been reserved for the interconnect attachment, Used only for interconnect attachment that has the encryption option as IPSEC. The addresses must be RFC 1918 IP address ranges. When creating HA VPN gateway over the interconnect attachment, if the attachment is configured to use an RFC 1918 IP address, then the VPN gateway?s IP address will be allocated from the IP address range specified here. For example, if the HA VPN gateway?s interface 0 is paired to this interconnect attachment, then an RFC 1918 IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this interconnect attachment. If this field is not specified for interconnect attachment that has encryption option as IPSEC, later on when creating HA VPN gateway on this interconnect attachment, the HA VPN gateway&#x27;s IP address will be allocated from regional external IP address pool.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400669 # Not currently available in all Interconnect locations.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700670 &quot;A String&quot;,
671 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800672 &quot;kind&quot;: &quot;compute#interconnectAttachment&quot;, # [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.
673 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.
Bu Sun Kim65020912020-05-20 12:08:20 -0700674 #
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800675 # To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment.
676 &quot;labels&quot;: { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
677 &quot;a_key&quot;: &quot;A String&quot;,
678 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800679 &quot;mtu&quot;: 42, # Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800680 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
681 &quot;operationalStatus&quot;: &quot;A String&quot;, # [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values:
682 # - OS_ACTIVE: The attachment has been turned up and is ready to use.
683 # - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
684 &quot;pairingKey&quot;: &quot;A String&quot;, # [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form &quot;XXXXX/region/domain&quot;
685 &quot;partnerAsn&quot;: &quot;A String&quot;, # Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.
686 &quot;partnerMetadata&quot;: { # Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments. # Informational metadata about Partner attachments from Partners to display to customers. Output only for for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.
687 &quot;interconnectName&quot;: &quot;A String&quot;, # Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner&#x27;s portal. For instance &quot;Chicago 1&quot;. This value may be validated to match approved Partner values.
688 &quot;partnerName&quot;: &quot;A String&quot;, # Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.
689 &quot;portalUrl&quot;: &quot;A String&quot;, # URL of the Partner&#x27;s portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values.
690 },
691 &quot;privateInterconnectInfo&quot;: { # Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED. # [Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.
692 &quot;tag8021q&quot;: 42, # [Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region.
693 },
694 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
695 &quot;router&quot;: &quot;A String&quot;, # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network &amp; region within which the Cloud Router is configured.
696 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
697 &quot;state&quot;: &quot;A String&quot;, # [Output Only] The current state of this attachment&#x27;s functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values:
698 # - ACTIVE: The attachment has been turned up and is ready to use.
699 # - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
700 # - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side.
701 # - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.
702 # - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it.
703 # - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted.
704 &quot;type&quot;: &quot;A String&quot;, # The type of interconnect attachment this is, which can take one of the following values:
705 # - DEDICATED: an attachment to a Dedicated Interconnect.
706 # - PARTNER: an attachment to a Partner Interconnect, created by the customer.
707 # - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.
708 &quot;vlanTag8021q&quot;: 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.
709 },
710 ],
711 &quot;kind&quot;: &quot;compute#interconnectAttachmentList&quot;, # [Output Only] Type of resource. Always compute#interconnectAttachmentList for lists of interconnect attachments.
712 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
713 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
714 &quot;warning&quot;: { # [Output Only] Informational warning message.
715 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
716 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
717 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
718 {
719 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
720 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Bu Sun Kim65020912020-05-20 12:08:20 -0700721 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700722 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800723 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
724 },
725}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700726</div>
727
728<div class="method">
729 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
730 <pre>Retrieves the next page of results.
731
732Args:
733 previous_request: The request for the previous page. (required)
734 previous_response: The response from the request for the previous page. (required)
735
736Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700737 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700738 page. Returns None if there are no more items in the collection.
739 </pre>
740</div>
741
742<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700743 <code class="details" id="patch">patch(project, region, interconnectAttachment, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700744 <pre>Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
745
746Args:
747 project: string, Project ID for this request. (required)
748 region: string, Name of the region scoping this request. (required)
749 interconnectAttachment: string, Name of the interconnect attachment to patch. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700750 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700751 The object takes the form of:
752
753{ # Represents an Interconnect Attachment (VLAN) resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700754 #
755 # You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. (== resource_for {$api_version}.interconnectAttachments ==)
756 &quot;adminEnabled&quot;: True or False, # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
757 &quot;bandwidth&quot;: &quot;A String&quot;, # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values:
758 # - BPS_50M: 50 Mbit/s
759 # - BPS_100M: 100 Mbit/s
760 # - BPS_200M: 200 Mbit/s
761 # - BPS_300M: 300 Mbit/s
762 # - BPS_400M: 400 Mbit/s
763 # - BPS_500M: 500 Mbit/s
764 # - BPS_1G: 1 Gbit/s
765 # - BPS_2G: 2 Gbit/s
766 # - BPS_5G: 5 Gbit/s
767 # - BPS_10G: 10 Gbit/s
768 # - BPS_20G: 20 Gbit/s
769 # - BPS_50G: 50 Gbit/s
770 &quot;candidateSubnets&quot;: [ # Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google&#x27;s edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.
771 &quot;A String&quot;,
772 ],
773 &quot;cloudRouterIpAddress&quot;: &quot;A String&quot;, # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
774 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
775 &quot;customerRouterIpAddress&quot;: &quot;A String&quot;, # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800776 &quot;dataplaneVersion&quot;: 42, # [Output Only] Dataplane version for this InterconnectAttachment.
Bu Sun Kim65020912020-05-20 12:08:20 -0700777 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource.
778 &quot;edgeAvailabilityDomain&quot;: &quot;A String&quot;, # Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values:
779 # - AVAILABILITY_DOMAIN_ANY
780 # - AVAILABILITY_DOMAIN_1
781 # - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700782 &quot;encryption&quot;: &quot;A String&quot;, # Indicates the user-supplied encryption option of this interconnect attachment:
783 # - NONE is the default value, which means that the attachment carries unencrypted traffic. VMs can send traffic to, or receive traffic from, this type of attachment.
784 # - IPSEC indicates that the attachment carries only traffic encrypted by an IPsec device such as an HA VPN gateway. VMs cannot directly send traffic to, or receive traffic from, such an attachment. To use IPsec-encrypted Cloud Interconnect, create the attachment using this option.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400785 # Not currently available in all Interconnect locations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700786 &quot;googleReferenceId&quot;: &quot;A String&quot;, # [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used.
787 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
788 &quot;interconnect&quot;: &quot;A String&quot;, # URL of the underlying Interconnect object that this attachment&#x27;s traffic will traverse through.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700789 &quot;ipsecInternalAddresses&quot;: [ # URL of addresses that have been reserved for the interconnect attachment, Used only for interconnect attachment that has the encryption option as IPSEC. The addresses must be RFC 1918 IP address ranges. When creating HA VPN gateway over the interconnect attachment, if the attachment is configured to use an RFC 1918 IP address, then the VPN gateway?s IP address will be allocated from the IP address range specified here. For example, if the HA VPN gateway?s interface 0 is paired to this interconnect attachment, then an RFC 1918 IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this interconnect attachment. If this field is not specified for interconnect attachment that has encryption option as IPSEC, later on when creating HA VPN gateway on this interconnect attachment, the HA VPN gateway&#x27;s IP address will be allocated from regional external IP address pool.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400790 # Not currently available in all Interconnect locations.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700791 &quot;A String&quot;,
792 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700793 &quot;kind&quot;: &quot;compute#interconnectAttachment&quot;, # [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.
794 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700795 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700796 # To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment.
797 &quot;labels&quot;: { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
798 &quot;a_key&quot;: &quot;A String&quot;,
799 },
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800800 &quot;mtu&quot;: 42, # Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.
Bu Sun Kim65020912020-05-20 12:08:20 -0700801 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
802 &quot;operationalStatus&quot;: &quot;A String&quot;, # [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values:
803 # - OS_ACTIVE: The attachment has been turned up and is ready to use.
804 # - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
805 &quot;pairingKey&quot;: &quot;A String&quot;, # [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form &quot;XXXXX/region/domain&quot;
806 &quot;partnerAsn&quot;: &quot;A String&quot;, # Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.
807 &quot;partnerMetadata&quot;: { # Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments. # Informational metadata about Partner attachments from Partners to display to customers. Output only for for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.
808 &quot;interconnectName&quot;: &quot;A String&quot;, # Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner&#x27;s portal. For instance &quot;Chicago 1&quot;. This value may be validated to match approved Partner values.
809 &quot;partnerName&quot;: &quot;A String&quot;, # Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.
810 &quot;portalUrl&quot;: &quot;A String&quot;, # URL of the Partner&#x27;s portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values.
811 },
812 &quot;privateInterconnectInfo&quot;: { # Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED. # [Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.
813 &quot;tag8021q&quot;: 42, # [Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region.
814 },
815 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
816 &quot;router&quot;: &quot;A String&quot;, # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network &amp; region within which the Cloud Router is configured.
817 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
818 &quot;state&quot;: &quot;A String&quot;, # [Output Only] The current state of this attachment&#x27;s functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values:
819 # - ACTIVE: The attachment has been turned up and is ready to use.
820 # - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.
821 # - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side.
822 # - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.
823 # - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it.
824 # - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted.
825 &quot;type&quot;: &quot;A String&quot;, # The type of interconnect attachment this is, which can take one of the following values:
826 # - DEDICATED: an attachment to a Dedicated Interconnect.
827 # - PARTNER: an attachment to a Partner Interconnect, created by the customer.
828 # - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.
829 &quot;vlanTag8021q&quot;: 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.
830}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700831
832 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
833
834For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
835
836The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
837
838Returns:
839 An object of the form:
840
841 { # Represents an Operation resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800842 #
843 # Google Compute Engine has three Operation resources:
844 #
845 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
846 #
847 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
848 #
849 # Operations can be global, regional or zonal.
850 # - For global operations, use the `globalOperations` resource.
851 # - For regional operations, use the `regionOperations` resource.
852 # - For zonal operations, use the `zonalOperations` resource.
853 #
854 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
855 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
856 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
857 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
858 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
859 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
860 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700861 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800862 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
863 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
864 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700865 },
866 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800867 },
868 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
869 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
870 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
871 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
872 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
873 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800874 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800875 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
876 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
877 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
878 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
879 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
880 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
881 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
882 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
883 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
884 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
885 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
886 {
887 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
888 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
889 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
890 {
891 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
892 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
893 },
894 ],
895 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
896 },
897 ],
898 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
899}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700900</div>
901
902<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700903 <code class="details" id="setLabels">setLabels(project, region, resource, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700904 <pre>Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation.
905
906Args:
907 project: string, Project ID for this request. (required)
908 region: string, The region for this request. (required)
909 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700910 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700911 The object takes the form of:
912
913{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800914 &quot;labelFingerprint&quot;: &quot;A String&quot;, # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.
915 &quot;labels&quot;: { # The labels to set for this resource.
916 &quot;a_key&quot;: &quot;A String&quot;,
917 },
918}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700919
920 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
921
922For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
923
924The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
925
926Returns:
927 An object of the form:
928
929 { # Represents an Operation resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800930 #
931 # Google Compute Engine has three Operation resources:
932 #
933 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
934 #
935 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
936 #
937 # Operations can be global, regional or zonal.
938 # - For global operations, use the `globalOperations` resource.
939 # - For regional operations, use the `regionOperations` resource.
940 # - For zonal operations, use the `zonalOperations` resource.
941 #
942 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
943 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
944 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
945 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
946 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
947 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
948 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim65020912020-05-20 12:08:20 -0700949 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800950 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
951 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
952 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim65020912020-05-20 12:08:20 -0700953 },
954 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800955 },
956 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
957 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
958 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
959 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
960 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
961 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800962 &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800963 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
964 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
965 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
966 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
967 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
968 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
969 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
970 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
971 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
972 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
973 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
974 {
975 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
976 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
977 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
978 {
979 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
980 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
981 },
982 ],
983 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
984 },
985 ],
986 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
987}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700988</div>
989
990<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700991 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700992 <pre>Returns permissions that a caller has on the specified resource.
993
994Args:
995 project: string, Project ID for this request. (required)
996 region: string, The name of the region for this request. (required)
997 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700998 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700999 The object takes the form of:
1000
1001{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001002 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
1003 &quot;A String&quot;,
1004 ],
1005}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001006
1007
1008Returns:
1009 An object of the form:
1010
1011 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -08001012 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
1013 &quot;A String&quot;,
1014 ],
1015}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001016</div>
1017
1018</body></html>