Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / compute_beta.interconnectLocations.html
blob: 1f248ff763434016668c5b747d0729ba9b55cd65 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<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">
78 <code><a href="#get">get(project, interconnectLocation)</a></code></p>
79<p class="firstline">Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request.</p>
80<p class="toc_element">
81 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
82<p class="firstline">Retrieves the list of interconnect locations available to the specified project.</p>
83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="get">get(project, interconnectLocation)</code>
89 <pre>Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request.
90
91Args:
92 project: string, Project ID for this request. (required)
93 interconnectLocation: string, Name of the interconnect location to return. (required)
94
95Returns:
96 An object of the form:
97
98 { # Represents an Interconnect Attachment (VLAN) Location resource.
99 #
100 # You can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments.
101 "status": "A String", # [Output Only] The status of this InterconnectLocation, which can take one of the following values:
102 # - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects.
103 # - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects.
104 "city": "A String", # [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands".
105 "kind": "compute#interconnectLocation", # [Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations.
106 "availabilityZone": "A String", # [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: "zone1" or "zone2".
107 "description": "A String", # [Output Only] An optional description of the resource.
108 "peeringdbFacilityId": "A String", # [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).
109 "facilityProvider": "A String", # [Output Only] The name of the provider for this facility (e.g., EQUINIX).
110 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
111 "regionInfos": [ # [Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions.
112 { # Information about any potential InterconnectAttachments between an Interconnect at a specific InterconnectLocation, and a specific Cloud Region.
113 "locationPresence": "A String", # Identifies the network presence of this location.
114 "region": "A String", # URL for the region of this location.
115 "expectedRttMs": "A String", # Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region.
116 },
117 ],
118 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
119 "address": "A String", # [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character.
120 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
121 "continent": "A String", # [Output Only] Continent for this location, which can take one of the following values:
122 # - AFRICA
123 # - ASIA_PAC
124 # - EUROPE
125 # - NORTH_AMERICA
126 # - SOUTH_AMERICA
127 "facilityProviderFacilityId": "A String", # [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1).
128 "name": "A String", # [Output Only] Name of the resource.
129 }</pre>
130</div>
131
132<div class="method">
133 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
134 <pre>Retrieves the list of interconnect locations available to the specified project.
135
136Args:
137 project: string, Project ID for this request. (required)
138 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
139
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]140You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]141
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]142Currently, only sorting by `name` or `creationTimestamp desc` is supported.
143 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`)
144 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.
145 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 -0700[diff] [blame]146
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]147For 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 -0700[diff] [blame]148
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]149You 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 -0700[diff] [blame]150
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]151To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]152
153Returns:
154 An object of the form:
155
156 { # Response to the list request, and contains a list of interconnect locations.
157 "nextPageToken": "A String", # [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.
158 "kind": "compute#interconnectLocationList", # [Output Only] Type of resource. Always compute#interconnectLocationList for lists of interconnect locations.
159 "items": [ # A list of InterconnectLocation resources.
160 { # Represents an Interconnect Attachment (VLAN) Location resource.
161 #
162 # You can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments.
163 "status": "A String", # [Output Only] The status of this InterconnectLocation, which can take one of the following values:
164 # - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects.
165 # - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects.
166 "city": "A String", # [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands".
167 "kind": "compute#interconnectLocation", # [Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations.
168 "availabilityZone": "A String", # [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: "zone1" or "zone2".
169 "description": "A String", # [Output Only] An optional description of the resource.
170 "peeringdbFacilityId": "A String", # [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).
171 "facilityProvider": "A String", # [Output Only] The name of the provider for this facility (e.g., EQUINIX).
172 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
173 "regionInfos": [ # [Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions.
174 { # Information about any potential InterconnectAttachments between an Interconnect at a specific InterconnectLocation, and a specific Cloud Region.
175 "locationPresence": "A String", # Identifies the network presence of this location.
176 "region": "A String", # URL for the region of this location.
177 "expectedRttMs": "A String", # Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region.
178 },
179 ],
180 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
181 "address": "A String", # [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character.
182 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
183 "continent": "A String", # [Output Only] Continent for this location, which can take one of the following values:
184 # - AFRICA
185 # - ASIA_PAC
186 # - EUROPE
187 # - NORTH_AMERICA
188 # - SOUTH_AMERICA
189 "facilityProviderFacilityId": "A String", # [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1).
190 "name": "A String", # [Output Only] Name of the resource.
191 },
192 ],
193 "warning": { # [Output Only] Informational warning message.
194 "message": "A String", # [Output Only] A human-readable description of the warning code.
195 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
196 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
197 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
198 {
199 "value": "A String", # [Output Only] A warning data value corresponding to the key.
200 "key": "A String", # [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).
201 },
202 ],
203 },
204 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
205 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
206 }</pre>
207</div>
208
209<div class="method">
210 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
211 <pre>Retrieves the next page of results.
212
213Args:
214 previous_request: The request for the previous page. (required)
215 previous_response: The response from the request for the previous page. (required)
216
217Returns:
218 A request object that you can call 'execute()' on to request the next
219 page. Returns None if there are no more items in the collection.
220 </pre>
221</div>
222
223</body></html>