Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4f877e562986034f25ea4246ad1256eabd339526 / . / docs / dyn / compute_v1.targetVpnGateways.html
blob: ceb326d7a512c3c002fd8134b613409c45b71461 [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.targetVpnGateways.html">targetVpnGateways</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 target VPN gateways 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, targetVpnGateway)</a></code></p>
85<p class="firstline">Deletes the specified TargetVpnGateway resource.</p>
86<p class="toc_element">
87 <code><a href="#get">get(project, region, targetVpnGateway)</a></code></p>
88<p class="firstline">Returns the specified TargetVpnGateway 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 TargetVpnGateway 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 TargetVpnGateway resources available to 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 target VPN gateways 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": { # A map of scoped target vpn gateway lists.
115 "a_key": { # [Output Only] Name of the scope containing this set of target vpn gateways.
116 "targetVpnGateways": [ # [Output Only] List of target vpn gateways contained in this scope.
117 {
118 "status": "A String", # [Output Only] The status of the VPN gateway.
119 "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
120 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
121 "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert and associated to a VPN gateway.
122 "A String",
123 ],
124 "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
125 "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
126 "A String",
127 ],
128 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
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 "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
132 "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.
133 },
134 ],
135 "warning": { # [Output Only] Informational warning which replaces the list of addresses when the list is empty.
136 "message": "A String", # [Output Only] Optional human-readable details for this warning.
137 "code": "A String", # [Output Only] The warning type identifier for this warning.
138 "data": [ # [Output Only] Metadata for this warning in key: value format.
139 {
140 "value": "A String", # [Output Only] A warning data value corresponding to the key.
141 "key": "A String", # [Output Only] A key for the warning data.
142 },
143 ],
144 },
145 },
146 },
147 "kind": "compute#targetVpnGatewayAggregatedList", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
148 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
149 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
150 }</pre>
151</div>
152
153<div class="method">
154 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
155 <pre>Retrieves the next page of results.
156
157Args:
158 previous_request: The request for the previous page. (required)
159 previous_response: The response from the request for the previous page. (required)
160
161Returns:
162 A request object that you can call 'execute()' on to request the next
163 page. Returns None if there are no more items in the collection.
164 </pre>
165</div>
166
167<div class="method">
168 <code class="details" id="delete">delete(project, region, targetVpnGateway)</code>
169 <pre>Deletes the specified TargetVpnGateway resource.
170
171Args:
172 project: string, Project ID for this request. (required)
173 region: string, The name of the region for this request. (required)
174 targetVpnGateway: string, Name of the TargetVpnGateway resource to delete. (required)
175
176Returns:
177 An object of the form:
178
179 { # An operation resource, used to manage asynchronous API requests.
180 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
181 "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.
182 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
183 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
184 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
185 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
186 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
187 "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.
188 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
189 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
190 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
191 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
192 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
193 {
194 "message": "A String", # [Output Only] Optional human-readable details for this warning.
195 "code": "A String", # [Output Only] The warning type identifier for this warning.
196 "data": [ # [Output Only] Metadata for this warning in key: value format.
197 {
198 "value": "A String", # [Output Only] A warning data value corresponding to the key.
199 "key": "A String", # [Output Only] A key for the warning data.
200 },
201 ],
202 },
203 ],
204 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
205 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
206 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
207 "name": "A String", # [Output Only] Name of the resource.
208 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
209 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
210 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
211 {
212 "message": "A String", # [Output Only] An optional, human-readable error message.
213 "code": "A String", # [Output Only] The error type identifier for this error.
214 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
215 },
216 ],
217 },
218 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
219 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
220 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
221 }</pre>
222</div>
223
224<div class="method">
225 <code class="details" id="get">get(project, region, targetVpnGateway)</code>
226 <pre>Returns the specified TargetVpnGateway resource.
227
228Args:
229 project: string, Project ID for this request. (required)
230 region: string, The name of the region for this request. (required)
231 targetVpnGateway: string, Name of the TargetVpnGateway resource to return. (required)
232
233Returns:
234 An object of the form:
235
236 {
237 "status": "A String", # [Output Only] The status of the VPN gateway.
238 "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
239 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
240 "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert and associated to a VPN gateway.
241 "A String",
242 ],
243 "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
244 "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
245 "A String",
246 ],
247 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
248 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
249 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
250 "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
251 "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.
252 }</pre>
253</div>
254
255<div class="method">
256 <code class="details" id="insert">insert(project, region, body)</code>
257 <pre>Creates a TargetVpnGateway resource in the specified project and region using the data included in the request.
258
259Args:
260 project: string, Project ID for this request. (required)
261 region: string, The name of the region for this request. (required)
262 body: object, The request body. (required)
263 The object takes the form of:
264
265{
266 "status": "A String", # [Output Only] The status of the VPN gateway.
267 "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
268 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
269 "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert and associated to a VPN gateway.
270 "A String",
271 ],
272 "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
273 "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
274 "A String",
275 ],
276 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
277 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
278 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
279 "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
280 "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.
281 }
282
283
284Returns:
285 An object of the form:
286
287 { # An operation resource, used to manage asynchronous API requests.
288 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
289 "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.
290 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
291 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
292 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
293 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
294 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
295 "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.
296 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
297 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
298 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
299 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
300 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
301 {
302 "message": "A String", # [Output Only] Optional human-readable details for this warning.
303 "code": "A String", # [Output Only] The warning type identifier for this warning.
304 "data": [ # [Output Only] Metadata for this warning in key: value format.
305 {
306 "value": "A String", # [Output Only] A warning data value corresponding to the key.
307 "key": "A String", # [Output Only] A key for the warning data.
308 },
309 ],
310 },
311 ],
312 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
313 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
314 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
315 "name": "A String", # [Output Only] Name of the resource.
316 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
317 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
318 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
319 {
320 "message": "A String", # [Output Only] An optional, human-readable error message.
321 "code": "A String", # [Output Only] The error type identifier for this error.
322 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
323 },
324 ],
325 },
326 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
327 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
328 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
329 }</pre>
330</div>
331
332<div class="method">
333 <code class="details" id="list">list(project, region, maxResults=None, pageToken=None, filter=None)</code>
334 <pre>Retrieves the list of TargetVpnGateway resources available to the specified project and region.
335
336Args:
337 project: string, Project ID for this request. (required)
338 region: string, The name of the region for this request. (required)
339 maxResults: integer, Maximum count of results to be returned.
340 pageToken: string, Tag returned by a previous list request when that list was truncated to maxResults. Used to continue a previous list request.
341 filter: string, Filter expression for filtering listed resources.
342
343Returns:
344 An object of the form:
345
346 { # Contains a list of TargetVpnGateway resources.
347 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
348 "items": [ # [Output Only] A list of TargetVpnGateway resources.
349 {
350 "status": "A String", # [Output Only] The status of the VPN gateway.
351 "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
352 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
353 "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert and associated to a VPN gateway.
354 "A String",
355 ],
356 "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
357 "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
358 "A String",
359 ],
360 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
361 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
362 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
363 "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
364 "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.
365 },
366 ],
367 "kind": "compute#targetVpnGatewayList", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
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 }</pre>
371</div>
372
373<div class="method">
374 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
375 <pre>Retrieves the next page of results.
376
377Args:
378 previous_request: The request for the previous page. (required)
379 previous_response: The response from the request for the previous page. (required)
380
381Returns:
382 A request object that you can call 'execute()' on to request the next
383 page. Returns None if there are no more items in the collection.
384 </pre>
385</div>
386
387</body></html>