blob: 517ee1deb0163dd531ebcee8c92f5af3648b6262 [file] [log] [blame]
Nathaniel Manista4f877e52015-06-15 16:44:50 +00001<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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700106 pageToken: string, Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.
107 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.
108
109The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
110
111For example, filter=name ne example-instance.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000112
113Returns:
114 An object of the form:
115
116 {
117 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
118 "items": { # [Output Only] A map of scoped vpn tunnel lists.
119 "a_key": { # Name of the scope containing this set of vpn tunnels.
120 "vpnTunnels": [ # List of vpn tunnels contained in this scope.
121 {
122 "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
123 "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.
124 "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
125 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
126 "peerIp": "A String", # IP address of the peer VPN gateway.
127 "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000128 "status": "A String", # [Output Only] The status of the VPN tunnel.
129 "sharedSecretHash": "A String", # Hash of the shared secret.
130 "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.
131 "sharedSecret": "A String", # Shared secret used to set the secure session between the GCE VPN gateway and the peer VPN gateway.
132 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
133 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700134 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
135 "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000136 },
137 ],
138 "warning": { # Informational warning which replaces the list of addresses when the list is empty.
139 "message": "A String", # [Output Only] Optional human-readable details for this warning.
140 "code": "A String", # [Output Only] The warning type identifier for this warning.
141 "data": [ # [Output Only] Metadata for this warning in key: value format.
142 {
143 "value": "A String", # [Output Only] A warning data value corresponding to the key.
144 "key": "A String", # [Output Only] A key for the warning data.
145 },
146 ],
147 },
148 },
149 },
150 "kind": "compute#vpnTunnelAggregatedList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
151 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700152 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000153 }</pre>
154</div>
155
156<div class="method">
157 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
158 <pre>Retrieves the next page of results.
159
160Args:
161 previous_request: The request for the previous page. (required)
162 previous_response: The response from the request for the previous page. (required)
163
164Returns:
165 A request object that you can call 'execute()' on to request the next
166 page. Returns None if there are no more items in the collection.
167 </pre>
168</div>
169
170<div class="method">
171 <code class="details" id="delete">delete(project, region, vpnTunnel)</code>
172 <pre>Deletes the specified VpnTunnel resource.
173
174Args:
175 project: string, Project ID for this request. (required)
176 region: string, The name of the region for this request. (required)
177 vpnTunnel: string, Name of the VpnTunnel resource to delete. (required)
178
179Returns:
180 An object of the form:
181
Takashi Matsuo06694102015-09-11 13:55:40 -0700182 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000183 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700184 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000185 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
186 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
187 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
188 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
189 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
190 "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.
191 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
192 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
193 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
194 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
195 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
196 {
197 "message": "A String", # [Output Only] Optional human-readable details for this warning.
198 "code": "A String", # [Output Only] The warning type identifier for this warning.
199 "data": [ # [Output Only] Metadata for this warning in key: value format.
200 {
201 "value": "A String", # [Output Only] A warning data value corresponding to the key.
202 "key": "A String", # [Output Only] A key for the warning data.
203 },
204 ],
205 },
206 ],
207 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
208 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
209 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
210 "name": "A String", # [Output Only] Name of the resource.
211 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
212 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
213 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
214 {
215 "message": "A String", # [Output Only] An optional, human-readable error message.
216 "code": "A String", # [Output Only] The error type identifier for this error.
217 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
218 },
219 ],
220 },
221 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700222 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000223 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
224 }</pre>
225</div>
226
227<div class="method">
228 <code class="details" id="get">get(project, region, vpnTunnel)</code>
229 <pre>Returns the specified VpnTunnel resource.
230
231Args:
232 project: string, Project ID for this request. (required)
233 region: string, The name of the region for this request. (required)
234 vpnTunnel: string, Name of the VpnTunnel resource to return. (required)
235
236Returns:
237 An object of the form:
238
239 {
240 "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
241 "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.
242 "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
243 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
244 "peerIp": "A String", # IP address of the peer VPN gateway.
245 "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000246 "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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700252 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
253 "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000254 }</pre>
255</div>
256
257<div class="method">
258 <code class="details" id="insert">insert(project, region, body)</code>
259 <pre>Creates a VpnTunnel resource in the specified project and region using the data included in the request.
260
261Args:
262 project: string, Project ID for this request. (required)
263 region: string, The name of the region for this request. (required)
264 body: object, The request body. (required)
265 The object takes the form of:
266
267{
268 "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
269 "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.
270 "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
271 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
272 "peerIp": "A String", # IP address of the peer VPN gateway.
273 "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000274 "status": "A String", # [Output Only] The status of the VPN tunnel.
275 "sharedSecretHash": "A String", # Hash of the shared secret.
276 "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.
277 "sharedSecret": "A String", # Shared secret used to set the secure session between the GCE VPN gateway and the peer VPN gateway.
278 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
279 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700280 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
281 "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000282 }
283
284
285Returns:
286 An object of the form:
287
Takashi Matsuo06694102015-09-11 13:55:40 -0700288 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000289 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700290 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000291 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
292 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
293 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
294 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
295 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
296 "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.
297 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
298 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
299 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
300 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
301 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
302 {
303 "message": "A String", # [Output Only] Optional human-readable details for this warning.
304 "code": "A String", # [Output Only] The warning type identifier for this warning.
305 "data": [ # [Output Only] Metadata for this warning in key: value format.
306 {
307 "value": "A String", # [Output Only] A warning data value corresponding to the key.
308 "key": "A String", # [Output Only] A key for the warning data.
309 },
310 ],
311 },
312 ],
313 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
314 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
315 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
316 "name": "A String", # [Output Only] Name of the resource.
317 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
318 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
319 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
320 {
321 "message": "A String", # [Output Only] An optional, human-readable error message.
322 "code": "A String", # [Output Only] The error type identifier for this error.
323 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
324 },
325 ],
326 },
327 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700328 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000329 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
330 }</pre>
331</div>
332
333<div class="method">
334 <code class="details" id="list">list(project, region, maxResults=None, pageToken=None, filter=None)</code>
335 <pre>Retrieves the list of VpnTunnel resources contained in the specified project and region.
336
337Args:
338 project: string, Project ID for this request. (required)
339 region: string, The name of the region for this request. (required)
340 maxResults: integer, Maximum count of results to be returned.
Takashi Matsuo06694102015-09-11 13:55:40 -0700341 pageToken: string, Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.
342 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.
343
344The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
345
346For example, filter=name ne example-instance.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000347
348Returns:
349 An object of the form:
350
351 { # Contains a list of VpnTunnel resources.
352 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
353 "items": [ # [Output Only] A list of VpnTunnel resources.
354 {
355 "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
356 "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.
357 "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
358 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
359 "peerIp": "A String", # IP address of the peer VPN gateway.
360 "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000361 "status": "A String", # [Output Only] The status of the VPN tunnel.
362 "sharedSecretHash": "A String", # Hash of the shared secret.
363 "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.
364 "sharedSecret": "A String", # Shared secret used to set the secure session between the GCE VPN gateway and the peer VPN gateway.
365 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
366 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700367 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
368 "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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000369 },
370 ],
371 "kind": "compute#vpnTunnelList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
372 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
373 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
374 }</pre>
375</div>
376
377<div class="method">
378 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
379 <pre>Retrieves the next page of results.
380
381Args:
382 previous_request: The request for the previous page. (required)
383 previous_response: The response from the request for the previous page. (required)
384
385Returns:
386 A request object that you can call 'execute()' on to request the next
387 page. Returns None if there are no more items in the collection.
388 </pre>
389</div>
390
391</body></html>