Debian Codegraph @

docs/dyn/compute_v1.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_v1.html">Compute Engine API</a> . <a href="compute_v1.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 },
159 ],
160 &quot;description&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional description of the resource.
161 &quot;facilityProvider&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the provider for this facility (e.g., EQUINIX).
162 &quot;facilityProviderFacilityId&quot;: &quot;A String&quot;, # Output only. [Output Only] A provider-assigned Identifier for this facility (e.g.,
163 # Ashburn-DC1).
164 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
165 # defined by the server.
166 &quot;kind&quot;: &quot;compute#interconnectLocation&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#interconnectLocation for interconnect locations.
167 &quot;name&quot;: &quot;A String&quot;, # Output only. [Output Only] Name of the resource.
168 &quot;peeringdbFacilityId&quot;: &quot;A String&quot;, # Output only. [Output Only] The peeringdb identifier for this facility (corresponding
169 # with a netfac type in peeringdb).
170 &quot;regionInfos&quot;: [ # Output only. [Output Only] A list of InterconnectLocation.RegionInfo objects, that
171 # describe parameters pertaining to the relation between this
172 # InterconnectLocation and various Google Cloud regions.
173 { # Information about any potential InterconnectAttachments between an
174 # Interconnect at a specific InterconnectLocation, and a specific Cloud
175 # Region.
176 &quot;expectedRttMs&quot;: &quot;A String&quot;, # Output only. Expected round-trip time in milliseconds, from this InterconnectLocation
177 # to a VM in this region.
178 &quot;l2ForwardingEnabled&quot;: True or False, # Output only. Identifies whether L2 Interconnect Attachments can be created in this
179 # region for interconnects that are in this location.
180 &quot;locationPresence&quot;: &quot;A String&quot;, # Output only. Identifies the network presence of this location.
181 &quot;region&quot;: &quot;A String&quot;, # Output only. URL for the region of this location.
182 },
183 ],
184 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
185 &quot;singleRegionProductionCriticalPeerLocations&quot;: [ # Output only. [Output Only] URLs of the other locations that can pair up with this
186 # location to support Single-Region 99.99% SLA. E.g. iad-zone1-1 and
187 # iad-zone2-5467 are Single-Region 99.99% peer locations of each other.
188 &quot;A String&quot;,
189 ],
190 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of this InterconnectLocation, which can take one
191 # of the following values:
192 #
193 # - CLOSED: The InterconnectLocation is closed and is unavailable for
194 # provisioning new Interconnects.
195 # - AVAILABLE: The InterconnectLocation is available for provisioning new
196 # Interconnects.
197 &quot;supportsPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
198 }</pre>
199 </div>
200
201 <div class="method">
202 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
203 <pre>Retrieves the list of interconnect locations available to the specified
204 project.
205
206 Args:
207 project: string, Project ID for this request. (required)
208 filter: string, A filter expression that filters resources listed in the response. Most
209 Compute resources support two types of filter expressions:
210 expressions that support regular expressions and expressions that follow
211 API improvement proposal AIP-160.
212 These two types of filter expressions cannot be mixed in one request.
213
214 If you want to use AIP-160, your expression must specify the field name, an
215 operator, and the value that you want to use for filtering. The value
216 must be a string, a number, or a boolean. The operator
217 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
218
219 For example, if you are filtering Compute Engine instances, you can
220 exclude instances named `example-instance` by specifying
221 `name != example-instance`.
222
223 The `:*` comparison can be used to test whether a key has been defined.
224 For example, to find all objects with `owner` label use:
225 ```
226 labels.owner:*
227 ```
228
229 You can also filter nested fields. For example, you could specify
230 `scheduling.automaticRestart = false` to include instances only
231 if they are not scheduled for automatic restarts. You can use filtering
232 on nested fields to filter based onresource labels.
233
234 To filter on multiple expressions, provide each separate expression within
235 parentheses. For example:
236 ```
237 (scheduling.automaticRestart = true)
238 (cpuPlatform = &quot;Intel Skylake&quot;)
239 ```
240 By default, each expression is an `AND` expression. However, you
241 can include `AND` and `OR` expressions explicitly.
242 For example:
243 ```
244 (cpuPlatform = &quot;Intel Skylake&quot;) OR
245 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
246 (scheduling.automaticRestart = true)
247 ```
248
249 If you want to use a regular expression, use the `eq` (equal) or `ne`
250 (not equal) operator against a single un-parenthesized expression with or
251 without quotes or against multiple parenthesized expressions. Examples:
252
253 `fieldname eq unquoted literal`
254 `fieldname eq &#x27;single quoted literal&#x27;`
255 `fieldname eq &quot;double quoted literal&quot;`
256 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
257
258 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
259 The literal value must match the entire field.
260
261 For example, to filter for instances that do not end with name &quot;instance&quot;,
262 you would use `name ne .*instance`.
263
264 You cannot combine constraints on multiple fields using regular
265 expressions.
266 maxResults: integer, The maximum number of results per page that should be returned.
267 If the number of available results is larger than `maxResults`,
268 Compute Engine returns a `nextPageToken` that can be used to get
269 the next page of results in subsequent list requests. Acceptable values are
270 `0` to `500`, inclusive. (Default: `500`)
271 orderBy: string, Sorts list results by a certain order. By default, results
272 are returned in alphanumerical order based on the resource name.
273
274 You can also sort results in descending order based on the creation
275 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
276 results based on the `creationTimestamp` field in
277 reverse chronological order (newest result first). Use this to sort
278 resources like operations so that the newest operation is returned first.
279
280 Currently, only sorting by `name` or
281 `creationTimestamp desc` is supported.
282 pageToken: string, Specifies a page token to use. Set `pageToken` to the
283 `nextPageToken` returned by a previous list request to get
284 the next page of results.
285 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
286 of failure. The default value is false.
287
288 For example, when partial success behavior is enabled, aggregatedList for a
289 single zone scope either returns all resources in the zone or no resources,
290 with an error code.
291 x__xgafv: string, V1 error format.
292 Allowed values
293 1 - v1 error format
294 2 - v2 error format
295
296 Returns:
297 An object of the form:
298
299 { # Response to the list request, and contains a list of interconnect locations.
300 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
301 &quot;items&quot;: [ # A list of InterconnectLocation resources.
302 { # Represents an Interconnect Attachment (VLAN) Location resource.
303 #
304 # You can use this resource to find location details about an Interconnect
305 # attachment (VLAN). For more information about interconnect attachments, read
306 # Creating VLAN Attachments.
307 &quot;address&quot;: &quot;A String&quot;, # Output only. [Output Only] The postal address of the Point of Presence, each line in
308 # the address is separated by a newline character.
309 &quot;availabilityZone&quot;: &quot;A String&quot;, # [Output Only] Availability zone for this InterconnectLocation. Within a
310 # metropolitan area (metro), maintenance will not be simultaneously scheduled
311 # in more than one availability zone. Example: &quot;zone1&quot; or &quot;zone2&quot;.
312 &quot;availableFeatures&quot;: [ # [Output only] List of features available at this InterconnectLocation,
313 # which can take one of the following values:
314 #
315 # - IF_MACSEC
316 # - IF_CROSS_SITE_NETWORK
317 &quot;A String&quot;,
318 ],
319 &quot;availableLinkTypes&quot;: [ # [Output only] List of link types available at this InterconnectLocation,
320 # which can take one of the following values:
321 #
322 # - LINK_TYPE_ETHERNET_10G_LR
323 # - LINK_TYPE_ETHERNET_100G_LR
324 # - LINK_TYPE_ETHERNET_400G_LR4
325 &quot;A String&quot;,
326 ],
327 &quot;city&quot;: &quot;A String&quot;, # [Output Only] Metropolitan area designator that indicates which city an
328 # interconnect is located.
329 # For example: &quot;Chicago, IL&quot;, &quot;Amsterdam, Netherlands&quot;.
330 &quot;continent&quot;: &quot;A String&quot;, # [Output Only] Continent for this location, which can take one of the
331 # following values:
332 #
333 # - AFRICA
334 # - ASIA_PAC
335 # - EUROPE
336 # - NORTH_AMERICA
337 # - SOUTH_AMERICA
338 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
339 # text format.
340 &quot;crossSiteInterconnectInfos&quot;: [ # [Output Only] A list of InterconnectLocation.CrossSiteInterconnectInfo
341 # objects, that describe where Cross-Site Interconnect wires may connect to
342 # from this location and associated connection parameters. Cross-Site
343 # Interconnect isn&#x27;t allowed to locations which are not listed.
344 { # Information about Cross-Site Interconnect wires which may be created
345 # between the containing location and another remote location.
346 &quot;city&quot;: &quot;A String&quot;, # Output only. The remote location for Cross-Site Interconnect wires. This specifies an
347 # InterconnectLocation city (metropolitan area designator), which itself
348 # may match multiple InterconnectLocations.
349 },
350 ],
351 &quot;description&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional description of the resource.
352 &quot;facilityProvider&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the provider for this facility (e.g., EQUINIX).
353 &quot;facilityProviderFacilityId&quot;: &quot;A String&quot;, # Output only. [Output Only] A provider-assigned Identifier for this facility (e.g.,
354 # Ashburn-DC1).
355 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
356 # defined by the server.
357 &quot;kind&quot;: &quot;compute#interconnectLocation&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#interconnectLocation for interconnect locations.
358 &quot;name&quot;: &quot;A String&quot;, # Output only. [Output Only] Name of the resource.
359 &quot;peeringdbFacilityId&quot;: &quot;A String&quot;, # Output only. [Output Only] The peeringdb identifier for this facility (corresponding
360 # with a netfac type in peeringdb).
361 &quot;regionInfos&quot;: [ # Output only. [Output Only] A list of InterconnectLocation.RegionInfo objects, that
362 # describe parameters pertaining to the relation between this
363 # InterconnectLocation and various Google Cloud regions.
364 { # Information about any potential InterconnectAttachments between an
365 # Interconnect at a specific InterconnectLocation, and a specific Cloud
366 # Region.
367 &quot;expectedRttMs&quot;: &quot;A String&quot;, # Output only. Expected round-trip time in milliseconds, from this InterconnectLocation
368 # to a VM in this region.
369 &quot;l2ForwardingEnabled&quot;: True or False, # Output only. Identifies whether L2 Interconnect Attachments can be created in this
370 # region for interconnects that are in this location.
371 &quot;locationPresence&quot;: &quot;A String&quot;, # Output only. Identifies the network presence of this location.
372 &quot;region&quot;: &quot;A String&quot;, # Output only. URL for the region of this location.
373 },
374 ],
375 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
376 &quot;singleRegionProductionCriticalPeerLocations&quot;: [ # Output only. [Output Only] URLs of the other locations that can pair up with this
377 # location to support Single-Region 99.99% SLA. E.g. iad-zone1-1 and
378 # iad-zone2-5467 are Single-Region 99.99% peer locations of each other.
379 &quot;A String&quot;,
380 ],
381 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of this InterconnectLocation, which can take one
382 # of the following values:
383 #
384 # - CLOSED: The InterconnectLocation is closed and is unavailable for
385 # provisioning new Interconnects.
386 # - AVAILABLE: The InterconnectLocation is available for provisioning new
387 # Interconnects.
388 &quot;supportsPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
389 },
390 ],
391 &quot;kind&quot;: &quot;compute#interconnectLocationList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#interconnectLocationList for lists of interconnect
392 # locations.
393 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
394 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
395 # the query parameter pageToken in the next list request.
396 # Subsequent list requests will have their own nextPageToken to
397 # continue paging through the results.
398 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
399 &quot;warning&quot;: { # [Output Only] Informational warning message.
400 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
401 # Engine returns NO_RESULTS_ON_PAGE if there
402 # are no results in the response.
403 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
404 # value format. For example:
405 #
406 # &quot;data&quot;: [
407 # {
408 # &quot;key&quot;: &quot;scope&quot;,
409 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
410 # }
411 {
412 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
413 # returned. For example, for warnings where there are no results in a list
414 # request for a particular zone, this key might be scope and
415 # the key value might be the zone name. Other examples might be a key
416 # indicating a deprecated resource and a suggested replacement, or a
417 # warning about invalid network settings (for example, if an instance
418 # attempts to perform IP forwarding but is not enabled for IP forwarding).
419 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
420 },
421 ],
422 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
423 },
424 }</pre>
425 </div>
426
427 <div class="method">
428 <code class="details" id="list_next">list_next()</code>
429 <pre>Retrieves the next page of results.
430
431 Args:
432 previous_request: The request for the previous page. (required)
433 previous_response: The response from the request for the previous page. (required)
434
435 Returns:
436 A request object that you can call &#x27;execute()&#x27; on to request the next
437 page. Returns None if there are no more items in the collection.
438 </pre>
439 </div>
440
441 </body></html>