blob: c7a12129002af2bea8bdafe3effb87eef0123d62 [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.interconnectLocations.html">interconnectLocations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070081 <code><a href="#get">get(project, interconnectLocation)</a></code></p>
82<p class="firstline">Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request.</p>
83<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070084 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070085<p class="firstline">Retrieves the list of interconnect locations available to the specified project.</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070091 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070096 <code class="details" id="get">get(project, interconnectLocation)</code>
97 <pre>Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request.
98
99Args:
100 project: string, Project ID for this request. (required)
101 interconnectLocation: string, Name of the interconnect location to return. (required)
102
103Returns:
104 An object of the form:
105
106 { # Represents an Interconnect Attachment (VLAN) Location resource.
107 #
108 # You can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments.
Bu Sun Kim65020912020-05-20 12:08:20 -0700109 &quot;address&quot;: &quot;A String&quot;, # [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character.
110 &quot;availabilityZone&quot;: &quot;A String&quot;, # [Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: &quot;zone1&quot; or &quot;zone2&quot;.
111 &quot;city&quot;: &quot;A String&quot;, # [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: &quot;Chicago, IL&quot;, &quot;Amsterdam, Netherlands&quot;.
112 &quot;continent&quot;: &quot;A String&quot;, # [Output Only] Continent for this location, which can take one of the following values:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700113 # - AFRICA
114 # - ASIA_PAC
115 # - EUROPE
116 # - NORTH_AMERICA
117 # - SOUTH_AMERICA
Bu Sun Kim65020912020-05-20 12:08:20 -0700118 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
119 &quot;description&quot;: &quot;A String&quot;, # [Output Only] An optional description of the resource.
120 &quot;facilityProvider&quot;: &quot;A String&quot;, # [Output Only] The name of the provider for this facility (e.g., EQUINIX).
121 &quot;facilityProviderFacilityId&quot;: &quot;A String&quot;, # [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1).
122 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
123 &quot;kind&quot;: &quot;compute#interconnectLocation&quot;, # [Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations.
124 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the resource.
125 &quot;peeringdbFacilityId&quot;: &quot;A String&quot;, # [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).
126 &quot;regionInfos&quot;: [ # [Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions.
127 { # Information about any potential InterconnectAttachments between an Interconnect at a specific InterconnectLocation, and a specific Cloud Region.
128 &quot;expectedRttMs&quot;: &quot;A String&quot;, # Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region.
129 &quot;locationPresence&quot;: &quot;A String&quot;, # Identifies the network presence of this location.
130 &quot;region&quot;: &quot;A String&quot;, # URL for the region of this location.
131 },
132 ],
133 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
134 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of this InterconnectLocation, which can take one of the following values:
135 # - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects.
136 # - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700137 }</pre>
138</div>
139
140<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700141 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700142 <pre>Retrieves the list of interconnect locations available to the specified project.
143
144Args:
145 project: string, Project ID for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700146 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 -0700147
Dan O'Mearadd494642020-05-01 07:42:23 -0700148For 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 -0700149
Dan O'Mearadd494642020-05-01 07:42:23 -0700150You 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 -0700151
Bu Sun Kim65020912020-05-20 12:08:20 -0700152To 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) ```
153 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`)
154 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
155
156You 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.
157
158Currently, only sorting by `name` or `creationTimestamp desc` is supported.
159 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700160 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700161
162Returns:
163 An object of the form:
164
165 { # Response to the list request, and contains a list of interconnect locations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700166 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
167 &quot;items&quot;: [ # A list of InterconnectLocation resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700168 { # Represents an Interconnect Attachment (VLAN) Location resource.
169 #
170 # You can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments.
Bu Sun Kim65020912020-05-20 12:08:20 -0700171 &quot;address&quot;: &quot;A String&quot;, # [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character.
172 &quot;availabilityZone&quot;: &quot;A String&quot;, # [Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: &quot;zone1&quot; or &quot;zone2&quot;.
173 &quot;city&quot;: &quot;A String&quot;, # [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: &quot;Chicago, IL&quot;, &quot;Amsterdam, Netherlands&quot;.
174 &quot;continent&quot;: &quot;A String&quot;, # [Output Only] Continent for this location, which can take one of the following values:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700175 # - AFRICA
176 # - ASIA_PAC
177 # - EUROPE
178 # - NORTH_AMERICA
179 # - SOUTH_AMERICA
Bu Sun Kim65020912020-05-20 12:08:20 -0700180 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
181 &quot;description&quot;: &quot;A String&quot;, # [Output Only] An optional description of the resource.
182 &quot;facilityProvider&quot;: &quot;A String&quot;, # [Output Only] The name of the provider for this facility (e.g., EQUINIX).
183 &quot;facilityProviderFacilityId&quot;: &quot;A String&quot;, # [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1).
184 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
185 &quot;kind&quot;: &quot;compute#interconnectLocation&quot;, # [Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations.
186 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the resource.
187 &quot;peeringdbFacilityId&quot;: &quot;A String&quot;, # [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).
188 &quot;regionInfos&quot;: [ # [Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions.
189 { # Information about any potential InterconnectAttachments between an Interconnect at a specific InterconnectLocation, and a specific Cloud Region.
190 &quot;expectedRttMs&quot;: &quot;A String&quot;, # Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region.
191 &quot;locationPresence&quot;: &quot;A String&quot;, # Identifies the network presence of this location.
192 &quot;region&quot;: &quot;A String&quot;, # URL for the region of this location.
193 },
194 ],
195 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
196 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of this InterconnectLocation, which can take one of the following values:
197 # - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects.
198 # - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700199 },
200 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700201 &quot;kind&quot;: &quot;compute#interconnectLocationList&quot;, # [Output Only] Type of resource. Always compute#interconnectLocationList for lists of interconnect locations.
202 &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.
203 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
204 &quot;warning&quot;: { # [Output Only] Informational warning message.
205 &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.
206 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
207 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700208 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700209 &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).
210 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700211 },
212 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700213 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700214 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700215 }</pre>
216</div>
217
218<div class="method">
219 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
220 <pre>Retrieves the next page of results.
221
222Args:
223 previous_request: The request for the previous page. (required)
224 previous_response: The response from the request for the previous page. (required)
225
226Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700227 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700228 page. Returns None if there are no more items in the collection.
229 </pre>
230</div>
231
232</body></html>