Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4f877e562986034f25ea4246ad1256eabd339526 / . / docs / dyn / compute_v1.vpnTunnels.html
blob: 4a46b8a3a8113b552cc8557c5d66638f45ccefde [file] [log] [blame]
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[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_v1.html">Compute Engine API</a> . <a href="compute_v1.vpnTunnels.html">vpnTunnels</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
79<p class="firstline">Retrieves the list of VPN tunnels grouped by scope.</p>
80<p class="toc_element">
81 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(project, region, vpnTunnel)</a></code></p>
85<p class="firstline">Deletes the specified VpnTunnel resource.</p>
86<p class="toc_element">
87 <code><a href="#get">get(project, region, vpnTunnel)</a></code></p>
88<p class="firstline">Returns the specified VpnTunnel resource.</p>
89<p class="toc_element">
90 <code><a href="#insert">insert(project, region, body)</a></code></p>
91<p class="firstline">Creates a VpnTunnel resource in the specified project and region using the data included in the request.</p>
92<p class="toc_element">
93 <code><a href="#list">list(project, region, maxResults=None, pageToken=None, filter=None)</a></code></p>
94<p class="firstline">Retrieves the list of VpnTunnel resources contained in the specified project and region.</p>
95<p class="toc_element">
96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
101 <pre>Retrieves the list of VPN tunnels grouped by scope.
102
103Args:
104 project: string, Project ID for this request. (required)
105 maxResults: integer, Maximum count of results to be returned.
106 pageToken: string, Tag returned by a previous list request when that list was truncated to maxResults. Used to continue a previous list request.
107 filter: string, Filter expression for filtering listed resources.
108
109Returns:
110 An object of the form:
111
112 {
113 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
114 "items": { # [Output Only] A map of scoped vpn tunnel lists.
115 "a_key": { # Name of the scope containing this set of vpn tunnels.
116 "vpnTunnels": [ # List of vpn tunnels contained in this scope.
117 {
118 "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
119 "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
120 "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
121 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
122 "peerIp": "A String", # IP address of the peer VPN gateway.
123 "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
124 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long and comply with RFC1035.
125 "status": "A String", # [Output Only] The status of the VPN tunnel.
126 "sharedSecretHash": "A String", # Hash of the shared secret.
127 "targetVpnGateway": "A String", # URL of the VPN gateway to which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
128 "sharedSecret": "A String", # Shared secret used to set the secure session between the GCE VPN gateway and the peer VPN gateway.
129 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
130 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
131 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
132 "ikeNetworks": [ # IKE networks to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
133 "A String",
134 ],
135 },
136 ],
137 "warning": { # Informational warning which replaces the list of addresses when the list is empty.
138 "message": "A String", # [Output Only] Optional human-readable details for this warning.
139 "code": "A String", # [Output Only] The warning type identifier for this warning.
140 "data": [ # [Output Only] Metadata for this warning in key: value format.
141 {
142 "value": "A String", # [Output Only] A warning data value corresponding to the key.
143 "key": "A String", # [Output Only] A key for the warning data.
144 },
145 ],
146 },
147 },
148 },
149 "kind": "compute#vpnTunnelAggregatedList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
150 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
151 "selfLink": "A String", # [Output Only] Server defined URL for this resource.
152 }</pre>
153</div>
154
155<div class="method">
156 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
157 <pre>Retrieves the next page of results.
158
159Args:
160 previous_request: The request for the previous page. (required)
161 previous_response: The response from the request for the previous page. (required)
162
163Returns:
164 A request object that you can call 'execute()' on to request the next
165 page. Returns None if there are no more items in the collection.
166 </pre>
167</div>
168
169<div class="method">
170 <code class="details" id="delete">delete(project, region, vpnTunnel)</code>
171 <pre>Deletes the specified VpnTunnel resource.
172
173Args:
174 project: string, Project ID for this request. (required)
175 region: string, The name of the region for this request. (required)
176 vpnTunnel: string, Name of the VpnTunnel resource to delete. (required)
177
178Returns:
179 An object of the form:
180
181 { # An operation resource, used to manage asynchronous API requests.
182 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
183 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
184 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
185 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
186 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
187 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
188 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
189 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
190 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
191 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
192 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
193 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
194 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
195 {
196 "message": "A String", # [Output Only] Optional human-readable details for this warning.
197 "code": "A String", # [Output Only] The warning type identifier for this warning.
198 "data": [ # [Output Only] Metadata for this warning in key: value format.
199 {
200 "value": "A String", # [Output Only] A warning data value corresponding to the key.
201 "key": "A String", # [Output Only] A key for the warning data.
202 },
203 ],
204 },
205 ],
206 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
207 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
208 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
209 "name": "A String", # [Output Only] Name of the resource.
210 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
211 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
212 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
213 {
214 "message": "A String", # [Output Only] An optional, human-readable error message.
215 "code": "A String", # [Output Only] The error type identifier for this error.
216 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
217 },
218 ],
219 },
220 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
221 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
222 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
223 }</pre>
224</div>
225
226<div class="method">
227 <code class="details" id="get">get(project, region, vpnTunnel)</code>
228 <pre>Returns the specified VpnTunnel resource.
229
230Args:
231 project: string, Project ID for this request. (required)
232 region: string, The name of the region for this request. (required)
233 vpnTunnel: string, Name of the VpnTunnel resource to return. (required)
234
235Returns:
236 An object of the form:
237
238 {
239 "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
240 "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
241 "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
242 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
243 "peerIp": "A String", # IP address of the peer VPN gateway.
244 "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
245 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long and comply with RFC1035.
246 "status": "A String", # [Output Only] The status of the VPN tunnel.
247 "sharedSecretHash": "A String", # Hash of the shared secret.
248 "targetVpnGateway": "A String", # URL of the VPN gateway to which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
249 "sharedSecret": "A String", # Shared secret used to set the secure session between the GCE VPN gateway and the peer VPN gateway.
250 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
251 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
252 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
253 "ikeNetworks": [ # IKE networks to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
254 "A String",
255 ],
256 }</pre>
257</div>
258
259<div class="method">
260 <code class="details" id="insert">insert(project, region, body)</code>
261 <pre>Creates a VpnTunnel resource in the specified project and region using the data included in the request.
262
263Args:
264 project: string, Project ID for this request. (required)
265 region: string, The name of the region for this request. (required)
266 body: object, The request body. (required)
267 The object takes the form of:
268
269{
270 "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
271 "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
272 "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
273 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
274 "peerIp": "A String", # IP address of the peer VPN gateway.
275 "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
276 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long and comply with RFC1035.
277 "status": "A String", # [Output Only] The status of the VPN tunnel.
278 "sharedSecretHash": "A String", # Hash of the shared secret.
279 "targetVpnGateway": "A String", # URL of the VPN gateway to which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
280 "sharedSecret": "A String", # Shared secret used to set the secure session between the GCE VPN gateway and the peer VPN gateway.
281 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
282 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
283 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
284 "ikeNetworks": [ # IKE networks to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
285 "A String",
286 ],
287 }
288
289
290Returns:
291 An object of the form:
292
293 { # An operation resource, used to manage asynchronous API requests.
294 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
295 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
296 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
297 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
298 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
299 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
300 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
301 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
302 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
303 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
304 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
305 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
306 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
307 {
308 "message": "A String", # [Output Only] Optional human-readable details for this warning.
309 "code": "A String", # [Output Only] The warning type identifier for this warning.
310 "data": [ # [Output Only] Metadata for this warning in key: value format.
311 {
312 "value": "A String", # [Output Only] A warning data value corresponding to the key.
313 "key": "A String", # [Output Only] A key for the warning data.
314 },
315 ],
316 },
317 ],
318 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
319 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
320 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
321 "name": "A String", # [Output Only] Name of the resource.
322 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
323 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
324 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
325 {
326 "message": "A String", # [Output Only] An optional, human-readable error message.
327 "code": "A String", # [Output Only] The error type identifier for this error.
328 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
329 },
330 ],
331 },
332 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
333 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
334 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
335 }</pre>
336</div>
337
338<div class="method">
339 <code class="details" id="list">list(project, region, maxResults=None, pageToken=None, filter=None)</code>
340 <pre>Retrieves the list of VpnTunnel resources contained in the specified project and region.
341
342Args:
343 project: string, Project ID for this request. (required)
344 region: string, The name of the region for this request. (required)
345 maxResults: integer, Maximum count of results to be returned.
346 pageToken: string, Tag returned by a previous list request when that list was truncated to maxResults. Used to continue a previous list request.
347 filter: string, Filter expression for filtering listed resources.
348
349Returns:
350 An object of the form:
351
352 { # Contains a list of VpnTunnel resources.
353 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
354 "items": [ # [Output Only] A list of VpnTunnel resources.
355 {
356 "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
357 "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
358 "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
359 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
360 "peerIp": "A String", # IP address of the peer VPN gateway.
361 "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
362 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long and comply with RFC1035.
363 "status": "A String", # [Output Only] The status of the VPN tunnel.
364 "sharedSecretHash": "A String", # Hash of the shared secret.
365 "targetVpnGateway": "A String", # URL of the VPN gateway to which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
366 "sharedSecret": "A String", # Shared secret used to set the secure session between the GCE VPN gateway and the peer VPN gateway.
367 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
368 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
369 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
370 "ikeNetworks": [ # IKE networks to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
371 "A String",
372 ],
373 },
374 ],
375 "kind": "compute#vpnTunnelList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
376 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
377 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
378 }</pre>
379</div>
380
381<div class="method">
382 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
383 <pre>Retrieves the next page of results.
384
385Args:
386 previous_request: The request for the previous page. (required)
387 previous_response: The response from the request for the previous page. (required)
388
389Returns:
390 A request object that you can call 'execute()' on to request the next
391 page. Returns None if there are no more items in the collection.
392 </pre>
393</div>
394
395</body></html>