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