Debian Codegraph @

docs/dyn/compute_alpha.interconnectLocations.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.interconnectLocations.html">interconnectLocations</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#get">get(project, interconnectLocation, x__xgafv=None)</a></code></p>
82 <p class="firstline">Returns the details for the specified interconnect location. Gets a list of</p>
83 <p class="toc_element">
84 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Retrieves the list of interconnect locations available to the specified</p>
86 <p class="toc_element">
87 <code><a href="#list_next">list_next()</a></code></p>
88 <p class="firstline">Retrieves the next page of results.</p>
89 <h3>Method Details</h3>
90 <div class="method">
91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93 </div>
94
95 <div class="method">
96 <code class="details" id="get">get(project, interconnectLocation, x__xgafv=None)</code>
97 <pre>Returns the details for the specified interconnect location. Gets a list of
98 available interconnect locations by making a list() request.
99
100 Args:
101 project: string, Project ID for this request. (required)
102 interconnectLocation: string, Name of the interconnect location to return. (required)
103 x__xgafv: string, V1 error format.
104 Allowed values
105 1 - v1 error format
106 2 - v2 error format
107
108 Returns:
109 An object of the form:
110
111 { # Represents an Interconnect Attachment (VLAN) Location resource.
112 #
113 # You can use this resource to find location details about an Interconnect
114 # attachment (VLAN). For more information about interconnect attachments, read
115 # Creating VLAN Attachments.
116 &quot;address&quot;: &quot;A String&quot;, # Output only. [Output Only] The postal address of the Point of Presence, each line in
117 # the address is separated by a newline character.
118 &quot;availabilityZone&quot;: &quot;A String&quot;, # [Output Only] Availability zone for this InterconnectLocation. Within a
119 # metropolitan area (metro), maintenance will not be simultaneously scheduled
120 # in more than one availability zone. Example: &quot;zone1&quot; or &quot;zone2&quot;.
121 &quot;availableFeatures&quot;: [ # [Output only] List of features available at this InterconnectLocation,
122 # which can take one of the following values:
123 #
124 # - IF_MACSEC
125 # - IF_CROSS_SITE_NETWORK
126 &quot;A String&quot;,
127 ],
128 &quot;availableLinkTypes&quot;: [ # [Output only] List of link types available at this InterconnectLocation,
129 # which can take one of the following values:
130 #
131 # - LINK_TYPE_ETHERNET_10G_LR
132 # - LINK_TYPE_ETHERNET_100G_LR
133 # - LINK_TYPE_ETHERNET_400G_LR4
134 &quot;A String&quot;,
135 ],
136 &quot;city&quot;: &quot;A String&quot;, # [Output Only] Metropolitan area designator that indicates which city an
137 # interconnect is located.
138 # For example: &quot;Chicago, IL&quot;, &quot;Amsterdam, Netherlands&quot;.
139 &quot;continent&quot;: &quot;A String&quot;, # [Output Only] Continent for this location, which can take one of the
140 # following values:
141 #
142 # - AFRICA
143 # - ASIA_PAC
144 # - EUROPE
145 # - NORTH_AMERICA
146 # - SOUTH_AMERICA
147 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
148 # text format.
149 &quot;crossSiteInterconnectInfos&quot;: [ # [Output Only] A list of InterconnectLocation.CrossSiteInterconnectInfo
150 # objects, that describe where Cross-Site Interconnect wires may connect to
151 # from this location and associated connection parameters. Cross-Site
152 # Interconnect isn&#x27;t allowed to locations which are not listed.
153 { # Information about Cross-Site Interconnect wires which may be created
154 # between the containing location and another remote location.
155 &quot;city&quot;: &quot;A String&quot;, # Output only. The remote location for Cross-Site Interconnect wires. This specifies an
156 # InterconnectLocation city (metropolitan area designator), which itself
157 # may match multiple InterconnectLocations.
158 &quot;maxSingleFlowGbps&quot;: 42, # Output only. The maximum gbps for a single flow to this metro.
159 # This limits the total bandwidth which may be configured per wire.
160 },
161 ],
162 &quot;description&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional description of the resource.
163 &quot;facilityProvider&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the provider for this facility (e.g., EQUINIX).
164 &quot;facilityProviderFacilityId&quot;: &quot;A String&quot;, # Output only. [Output Only] A provider-assigned Identifier for this facility (e.g.,
165 # Ashburn-DC1).
166 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
167 # defined by the server.
168 &quot;kind&quot;: &quot;compute#interconnectLocation&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#interconnectLocation for interconnect locations.
169 &quot;name&quot;: &quot;A String&quot;, # Output only. [Output Only] Name of the resource.
170 &quot;peeringdbFacilityId&quot;: &quot;A String&quot;, # Output only. [Output Only] The peeringdb identifier for this facility (corresponding
171 # with a netfac type in peeringdb).
172 &quot;regionInfos&quot;: [ # Output only. [Output Only] A list of InterconnectLocation.RegionInfo objects, that
173 # describe parameters pertaining to the relation between this
174 # InterconnectLocation and various Google Cloud regions.
175 { # Information about any potential InterconnectAttachments between an
176 # Interconnect at a specific InterconnectLocation, and a specific Cloud
177 # Region.
178 &quot;expectedRttMs&quot;: &quot;A String&quot;, # Output only. Expected round-trip time in milliseconds, from this InterconnectLocation
179 # to a VM in this region.
180 &quot;l2ForwardingEnabled&quot;: True or False, # Output only. Identifies whether L2 Interconnect Attachments can be created in this
181 # region for interconnects that are in this location.
182 &quot;locationPresence&quot;: &quot;A String&quot;, # Output only. Identifies the network presence of this location.
183 &quot;region&quot;: &quot;A String&quot;, # Output only. URL for the region of this location.
184 },
185 ],
186 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
187 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
188 &quot;singleRegionProductionCriticalPeerLocations&quot;: [ # Output only. [Output Only] URLs of the other locations that can pair up with this
189 # location to support Single-Region 99.99% SLA. E.g. iad-zone1-1 and
190 # iad-zone2-5467 are Single-Region 99.99% peer locations of each other.
191 &quot;A String&quot;,
192 ],
193 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of this InterconnectLocation, which can take one
194 # of the following values:
195 #
196 # - CLOSED: The InterconnectLocation is closed and is unavailable for
197 # provisioning new Interconnects.
198 # - AVAILABLE: The InterconnectLocation is available for provisioning new
199 # Interconnects.
200 &quot;supportsPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
201 }</pre>
202 </div>
203
204 <div class="method">
205 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
206 <pre>Retrieves the list of interconnect locations available to the specified
207 project.
208
209 Args:
210 project: string, Project ID for this request. (required)
211 filter: string, A filter expression that filters resources listed in the response. Most
212 Compute resources support two types of filter expressions:
213 expressions that support regular expressions and expressions that follow
214 API improvement proposal AIP-160.
215 These two types of filter expressions cannot be mixed in one request.
216
217 If you want to use AIP-160, your expression must specify the field name, an
218 operator, and the value that you want to use for filtering. The value
219 must be a string, a number, or a boolean. The operator
220 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
221
222 For example, if you are filtering Compute Engine instances, you can
223 exclude instances named `example-instance` by specifying
224 `name != example-instance`.
225
226 The `:*` comparison can be used to test whether a key has been defined.
227 For example, to find all objects with `owner` label use:
228 ```
229 labels.owner:*
230 ```
231
232 You can also filter nested fields. For example, you could specify
233 `scheduling.automaticRestart = false` to include instances only
234 if they are not scheduled for automatic restarts. You can use filtering
235 on nested fields to filter based onresource labels.
236
237 To filter on multiple expressions, provide each separate expression within
238 parentheses. For example:
239 ```
240 (scheduling.automaticRestart = true)
241 (cpuPlatform = &quot;Intel Skylake&quot;)
242 ```
243 By default, each expression is an `AND` expression. However, you
244 can include `AND` and `OR` expressions explicitly.
245 For example:
246 ```
247 (cpuPlatform = &quot;Intel Skylake&quot;) OR
248 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
249 (scheduling.automaticRestart = true)
250 ```
251
252 If you want to use a regular expression, use the `eq` (equal) or `ne`
253 (not equal) operator against a single un-parenthesized expression with or
254 without quotes or against multiple parenthesized expressions. Examples:
255
256 `fieldname eq unquoted literal`
257 `fieldname eq &#x27;single quoted literal&#x27;`
258 `fieldname eq &quot;double quoted literal&quot;`
259 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
260
261 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
262 The literal value must match the entire field.
263
264 For example, to filter for instances that do not end with name &quot;instance&quot;,
265 you would use `name ne .*instance`.
266
267 You cannot combine constraints on multiple fields using regular
268 expressions.
269 maxResults: integer, The maximum number of results per page that should be returned.
270 If the number of available results is larger than `maxResults`,
271 Compute Engine returns a `nextPageToken` that can be used to get
272 the next page of results in subsequent list requests. Acceptable values are
273 `0` to `500`, inclusive. (Default: `500`)
274 orderBy: string, Sorts list results by a certain order. By default, results
275 are returned in alphanumerical order based on the resource name.
276
277 You can also sort results in descending order based on the creation
278 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
279 results based on the `creationTimestamp` field in
280 reverse chronological order (newest result first). Use this to sort
281 resources like operations so that the newest operation is returned first.
282
283 Currently, only sorting by `name` or
284 `creationTimestamp desc` is supported.
285 pageToken: string, Specifies a page token to use. Set `pageToken` to the
286 `nextPageToken` returned by a previous list request to get
287 the next page of results.
288 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
289 of failure. The default value is false.
290
291 For example, when partial success behavior is enabled, aggregatedList for a
292 single zone scope either returns all resources in the zone or no resources,
293 with an error code.
294 x__xgafv: string, V1 error format.
295 Allowed values
296 1 - v1 error format
297 2 - v2 error format
298
299 Returns:
300 An object of the form:
301
302 { # Response to the list request, and contains a list of interconnect locations.
303 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
304 &quot;items&quot;: [ # A list of InterconnectLocation resources.
305 { # Represents an Interconnect Attachment (VLAN) Location resource.
306 #
307 # You can use this resource to find location details about an Interconnect
308 # attachment (VLAN). For more information about interconnect attachments, read
309 # Creating VLAN Attachments.
310 &quot;address&quot;: &quot;A String&quot;, # Output only. [Output Only] The postal address of the Point of Presence, each line in
311 # the address is separated by a newline character.
312 &quot;availabilityZone&quot;: &quot;A String&quot;, # [Output Only] Availability zone for this InterconnectLocation. Within a
313 # metropolitan area (metro), maintenance will not be simultaneously scheduled
314 # in more than one availability zone. Example: &quot;zone1&quot; or &quot;zone2&quot;.
315 &quot;availableFeatures&quot;: [ # [Output only] List of features available at this InterconnectLocation,
316 # which can take one of the following values:
317 #
318 # - IF_MACSEC
319 # - IF_CROSS_SITE_NETWORK
320 &quot;A String&quot;,
321 ],
322 &quot;availableLinkTypes&quot;: [ # [Output only] List of link types available at this InterconnectLocation,
323 # which can take one of the following values:
324 #
325 # - LINK_TYPE_ETHERNET_10G_LR
326 # - LINK_TYPE_ETHERNET_100G_LR
327 # - LINK_TYPE_ETHERNET_400G_LR4
328 &quot;A String&quot;,
329 ],
330 &quot;city&quot;: &quot;A String&quot;, # [Output Only] Metropolitan area designator that indicates which city an
331 # interconnect is located.
332 # For example: &quot;Chicago, IL&quot;, &quot;Amsterdam, Netherlands&quot;.
333 &quot;continent&quot;: &quot;A String&quot;, # [Output Only] Continent for this location, which can take one of the
334 # following values:
335 #
336 # - AFRICA
337 # - ASIA_PAC
338 # - EUROPE
339 # - NORTH_AMERICA
340 # - SOUTH_AMERICA
341 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
342 # text format.
343 &quot;crossSiteInterconnectInfos&quot;: [ # [Output Only] A list of InterconnectLocation.CrossSiteInterconnectInfo
344 # objects, that describe where Cross-Site Interconnect wires may connect to
345 # from this location and associated connection parameters. Cross-Site
346 # Interconnect isn&#x27;t allowed to locations which are not listed.
347 { # Information about Cross-Site Interconnect wires which may be created
348 # between the containing location and another remote location.
349 &quot;city&quot;: &quot;A String&quot;, # Output only. The remote location for Cross-Site Interconnect wires. This specifies an
350 # InterconnectLocation city (metropolitan area designator), which itself
351 # may match multiple InterconnectLocations.
352 &quot;maxSingleFlowGbps&quot;: 42, # Output only. The maximum gbps for a single flow to this metro.
353 # This limits the total bandwidth which may be configured per wire.
354 },
355 ],
356 &quot;description&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional description of the resource.
357 &quot;facilityProvider&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the provider for this facility (e.g., EQUINIX).
358 &quot;facilityProviderFacilityId&quot;: &quot;A String&quot;, # Output only. [Output Only] A provider-assigned Identifier for this facility (e.g.,
359 # Ashburn-DC1).
360 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
361 # defined by the server.
362 &quot;kind&quot;: &quot;compute#interconnectLocation&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#interconnectLocation for interconnect locations.
363 &quot;name&quot;: &quot;A String&quot;, # Output only. [Output Only] Name of the resource.
364 &quot;peeringdbFacilityId&quot;: &quot;A String&quot;, # Output only. [Output Only] The peeringdb identifier for this facility (corresponding
365 # with a netfac type in peeringdb).
366 &quot;regionInfos&quot;: [ # Output only. [Output Only] A list of InterconnectLocation.RegionInfo objects, that
367 # describe parameters pertaining to the relation between this
368 # InterconnectLocation and various Google Cloud regions.
369 { # Information about any potential InterconnectAttachments between an
370 # Interconnect at a specific InterconnectLocation, and a specific Cloud
371 # Region.
372 &quot;expectedRttMs&quot;: &quot;A String&quot;, # Output only. Expected round-trip time in milliseconds, from this InterconnectLocation
373 # to a VM in this region.
374 &quot;l2ForwardingEnabled&quot;: True or False, # Output only. Identifies whether L2 Interconnect Attachments can be created in this
375 # region for interconnects that are in this location.
376 &quot;locationPresence&quot;: &quot;A String&quot;, # Output only. Identifies the network presence of this location.
377 &quot;region&quot;: &quot;A String&quot;, # Output only. URL for the region of this location.
378 },
379 ],
380 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
381 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
382 &quot;singleRegionProductionCriticalPeerLocations&quot;: [ # Output only. [Output Only] URLs of the other locations that can pair up with this
383 # location to support Single-Region 99.99% SLA. E.g. iad-zone1-1 and
384 # iad-zone2-5467 are Single-Region 99.99% peer locations of each other.
385 &quot;A String&quot;,
386 ],
387 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of this InterconnectLocation, which can take one
388 # of the following values:
389 #
390 # - CLOSED: The InterconnectLocation is closed and is unavailable for
391 # provisioning new Interconnects.
392 # - AVAILABLE: The InterconnectLocation is available for provisioning new
393 # Interconnects.
394 &quot;supportsPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
395 },
396 ],
397 &quot;kind&quot;: &quot;compute#interconnectLocationList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#interconnectLocationList for lists of interconnect
398 # locations.
399 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
400 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
401 # the query parameter pageToken in the next list request.
402 # Subsequent list requests will have their own nextPageToken to
403 # continue paging through the results.
404 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
405 &quot;warning&quot;: { # [Output Only] Informational warning message.
406 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
407 # Engine returns NO_RESULTS_ON_PAGE if there
408 # are no results in the response.
409 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
410 # value format. For example:
411 #
412 # &quot;data&quot;: [
413 # {
414 # &quot;key&quot;: &quot;scope&quot;,
415 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
416 # }
417 {
418 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
419 # returned. For example, for warnings where there are no results in a list
420 # request for a particular zone, this key might be scope and
421 # the key value might be the zone name. Other examples might be a key
422 # indicating a deprecated resource and a suggested replacement, or a
423 # warning about invalid network settings (for example, if an instance
424 # attempts to perform IP forwarding but is not enabled for IP forwarding).
425 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
426 },
427 ],
428 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
429 },
430 }</pre>
431 </div>
432
433 <div class="method">
434 <code class="details" id="list_next">list_next()</code>
435 <pre>Retrieves the next page of results.
436
437 Args:
438 previous_request: The request for the previous page. (required)
439 previous_response: The response from the request for the previous page. (required)
440
441 Returns:
442 A request object that you can call &#x27;execute()&#x27; on to request the next
443 page. Returns None if there are no more items in the collection.
444 </pre>
445 </div>
446
447 </body></html>