Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / compute_alpha.interconnectLocations.html
blob: 962e934473804ac63f890d4c8e3db7f477ac0827 [file] [log] [blame]
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[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_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="#get">get(project, interconnectLocation)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]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<p class="toc_element">
87 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
88<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="get">get(project, interconnectLocation)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92 <pre>Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]93
94Args:
95 project: string, Project ID for this request. (required)
96 interconnectLocation: string, Name of the interconnect location to return. (required)
97
98Returns:
99 An object of the form:
100
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]101 { # Represents an Interconnect Attachment (VLAN) Location resource.
102 #
103 # You can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments.
104 "status": "A String", # [Output Only] The status of this InterconnectLocation, which can take one of the following values:
105 # - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects.
106 # - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects.
107 "city": "A String", # [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands".
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]108 "kind": "compute#interconnectLocation", # [Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]109 "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".
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]110 "description": "A String", # [Output Only] An optional description of the resource.
111 "peeringdbFacilityId": "A String", # [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).
112 "facilityProvider": "A String", # [Output Only] The name of the provider for this facility (e.g., EQUINIX).
113 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
114 "regionInfos": [ # [Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions.
115 { # Information about any potential InterconnectAttachments between an Interconnect at a specific InterconnectLocation, and a specific Cloud Region.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]116 "locationPresence": "A String", # Identifies the network presence of this location.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]117 "region": "A String", # URL for the region of this location.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]118 "expectedRttMs": "A String", # Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region.
119 },
120 ],
121 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
122 "address": "A String", # [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]123 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]124 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]125 "continent": "A String", # [Output Only] Continent for this location, which can take one of the following values:
126 # - AFRICA
127 # - ASIA_PAC
128 # - EUROPE
129 # - NORTH_AMERICA
130 # - SOUTH_AMERICA
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]131 "facilityProviderFacilityId": "A String", # [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1).
132 "name": "A String", # [Output Only] Name of the resource.
133 }</pre>
134</div>
135
136<div class="method">
137 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
138 <pre>Retrieves the list of interconnect locations available to the specified project.
139
140Args:
141 project: string, Project ID for this request. (required)
142 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
143
144You 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.
145
146Currently, only sorting by name or creationTimestamp desc is supported.
147 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)
148 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]149 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 =, !=, >, or <.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]150
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]151For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]152
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]153You 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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]154
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]155To 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).
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]156
157Returns:
158 An object of the form:
159
160 { # Response to the list request, and contains a list of interconnect locations.
161 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]162 "kind": "compute#interconnectLocationList", # [Output Only] Type of resource. Always compute#interconnectLocationList for lists of interconnect locations.
163 "items": [ # A list of InterconnectLocation resources.
164 { # Represents an Interconnect Attachment (VLAN) Location resource.
165 #
166 # You can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments.
167 "status": "A String", # [Output Only] The status of this InterconnectLocation, which can take one of the following values:
168 # - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects.
169 # - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects.
170 "city": "A String", # [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands".
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]171 "kind": "compute#interconnectLocation", # [Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]172 "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".
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]173 "description": "A String", # [Output Only] An optional description of the resource.
174 "peeringdbFacilityId": "A String", # [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).
175 "facilityProvider": "A String", # [Output Only] The name of the provider for this facility (e.g., EQUINIX).
176 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
177 "regionInfos": [ # [Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions.
178 { # Information about any potential InterconnectAttachments between an Interconnect at a specific InterconnectLocation, and a specific Cloud Region.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]179 "locationPresence": "A String", # Identifies the network presence of this location.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]180 "region": "A String", # URL for the region of this location.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]181 "expectedRttMs": "A String", # Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region.
182 },
183 ],
184 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
185 "address": "A String", # [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]186 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]187 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]188 "continent": "A String", # [Output Only] Continent for this location, which can take one of the following values:
189 # - AFRICA
190 # - ASIA_PAC
191 # - EUROPE
192 # - NORTH_AMERICA
193 # - SOUTH_AMERICA
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]194 "facilityProviderFacilityId": "A String", # [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1).
195 "name": "A String", # [Output Only] Name of the resource.
196 },
197 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]198 "warning": { # [Output Only] Informational warning message.
199 "message": "A String", # [Output Only] A human-readable description of the warning code.
200 "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.
201 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
202 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
203 {
204 "value": "A String", # [Output Only] A warning data value corresponding to the key.
205 "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).
206 },
207 ],
208 },
209 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]210 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
211 }</pre>
212</div>
213
214<div class="method">
215 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
216 <pre>Retrieves the next page of results.
217
218Args:
219 previous_request: The request for the previous page. (required)
220 previous_response: The response from the request for the previous page. (required)
221
222Returns:
223 A request object that you can call 'execute()' on to request the next
224 page. Returns None if there are no more items in the collection.
225 </pre>
226</div>
227
228<div class="method">
229 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
230 <pre>Returns permissions that a caller has on the specified resource.
231
232Args:
233 project: string, Project ID for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]234 resource: string, Name or id of the resource for this request. (required)
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]235 body: object, The request body. (required)
236 The object takes the form of:
237
238{
239 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
240 "A String",
241 ],
242 }
243
244
245Returns:
246 An object of the form:
247
248 {
249 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
250 "A String",
251 ],
252 }</pre>
253</div>
254
255</body></html>