Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / ea3a5e1b5572e5438ba86ec0074f60029bd94855 / . / docs / dyn / compute_v1.vpnTunnels.html
blob: 1198a10f0a98f16a942dd45e15c34c39ee85e57f [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">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]78 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]79<p class="firstline">Retrieves an aggregated list of VPN tunnels.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]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>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]88<p class="firstline">Returns the specified VpnTunnel resource. Get a list of available VPN tunnels by making a list() request.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]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">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]93 <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]94<p class="firstline">Retrieves a list of VpnTunnel resources contained in the specified project and region.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]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">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]100 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]101 <pre>Retrieves an aggregated list of VPN tunnels.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]102
103Args:
104 project: string, Project ID for this request. (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]105 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
106
107You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
108
109Currently, only sorting by name or creationTimestamp desc is supported.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]110 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
111 pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
112 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]113
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]114The 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 you are filtering by (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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]115
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]116For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]117
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]118You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]119
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]120To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]121
122Returns:
123 An object of the form:
124
125 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]126 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]127 "items": { # [Output Only] A map of scoped vpn tunnel lists.
128 "a_key": { # Name of the scope containing this set of vpn tunnels.
129 "vpnTunnels": [ # List of vpn tunnels contained in this scope.
130 {
131 "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
132 "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.
133 "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]134 "remoteTrafficSelector": [ # Remote traffic selectors 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.
135 "A String",
136 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]137 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]138 "peerIp": "A String", # IP address of the peer VPN gateway.
139 "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]140 "localTrafficSelector": [ # Local traffic selector 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.
141 "A String",
142 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]143 "targetVpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]144 "status": "A String", # [Output Only] The status of the VPN tunnel.
145 "sharedSecretHash": "A String", # Hash of the shared secret.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]146 "router": "A String", # URL of router resource to be used for dynamic routing.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]147 "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]148 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]149 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]150 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]151 "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]152 },
153 ],
154 "warning": { # Informational warning which replaces the list of addresses when the list is empty.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]155 "message": "A String", # [Output Only] A human-readable description of the warning code.
156 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
157 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
158 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]159 {
160 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]161 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]162 },
163 ],
164 },
165 },
166 },
167 "kind": "compute#vpnTunnelAggregatedList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]168 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]169 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]170 }</pre>
171</div>
172
173<div class="method">
174 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
175 <pre>Retrieves the next page of results.
176
177Args:
178 previous_request: The request for the previous page. (required)
179 previous_response: The response from the request for the previous page. (required)
180
181Returns:
182 A request object that you can call 'execute()' on to request the next
183 page. Returns None if there are no more items in the collection.
184 </pre>
185</div>
186
187<div class="method">
188 <code class="details" id="delete">delete(project, region, vpnTunnel)</code>
189 <pre>Deletes the specified VpnTunnel resource.
190
191Args:
192 project: string, Project ID for this request. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]193 region: string, Name of the region for this request. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]194 vpnTunnel: string, Name of the VpnTunnel resource to delete. (required)
195
196Returns:
197 An object of the form:
198
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]199 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]200 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
201 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]202 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]203 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
204 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
205 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
206 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]207 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]208 "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
209 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]210 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]211 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
212 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]213 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
214 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]215 "message": "A String", # [Output Only] A human-readable description of the warning code.
216 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
217 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
218 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]219 {
220 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]221 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]222 },
223 ],
224 },
225 ],
226 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]227 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
228 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]229 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]230 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]231 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
232 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
233 {
234 "message": "A String", # [Output Only] An optional, human-readable error message.
235 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]236 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]237 },
238 ],
239 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]240 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]241 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]242 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]243 }</pre>
244</div>
245
246<div class="method">
247 <code class="details" id="get">get(project, region, vpnTunnel)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]248 <pre>Returns the specified VpnTunnel resource. Get a list of available VPN tunnels by making a list() request.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]249
250Args:
251 project: string, Project ID for this request. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]252 region: string, Name of the region for this request. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]253 vpnTunnel: string, Name of the VpnTunnel resource to return. (required)
254
255Returns:
256 An object of the form:
257
258 {
259 "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
260 "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.
261 "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]262 "remoteTrafficSelector": [ # Remote traffic selectors 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.
263 "A String",
264 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]265 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]266 "peerIp": "A String", # IP address of the peer VPN gateway.
267 "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]268 "localTrafficSelector": [ # Local traffic selector 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.
269 "A String",
270 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]271 "targetVpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]272 "status": "A String", # [Output Only] The status of the VPN tunnel.
273 "sharedSecretHash": "A String", # Hash of the shared secret.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]274 "router": "A String", # URL of router resource to be used for dynamic routing.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]275 "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]276 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]277 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]278 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]279 "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]280 }</pre>
281</div>
282
283<div class="method">
284 <code class="details" id="insert">insert(project, region, body)</code>
285 <pre>Creates a VpnTunnel resource in the specified project and region using the data included in the request.
286
287Args:
288 project: string, Project ID for this request. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]289 region: string, Name of the region for this request. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]290 body: object, The request body. (required)
291 The object takes the form of:
292
293{
294 "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
295 "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.
296 "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]297 "remoteTrafficSelector": [ # Remote traffic selectors 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.
298 "A String",
299 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]300 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]301 "peerIp": "A String", # IP address of the peer VPN gateway.
302 "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]303 "localTrafficSelector": [ # Local traffic selector 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.
304 "A String",
305 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]306 "targetVpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]307 "status": "A String", # [Output Only] The status of the VPN tunnel.
308 "sharedSecretHash": "A String", # Hash of the shared secret.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]309 "router": "A String", # URL of router resource to be used for dynamic routing.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]310 "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]311 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]312 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]313 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]314 "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]315 }
316
317
318Returns:
319 An object of the form:
320
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]321 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]322 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
323 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]324 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]325 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
326 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
327 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
328 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]329 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]330 "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
331 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]332 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]333 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
334 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]335 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
336 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]337 "message": "A String", # [Output Only] A human-readable description of the warning code.
338 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
339 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
340 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]341 {
342 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]343 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]344 },
345 ],
346 },
347 ],
348 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]349 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
350 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]351 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]352 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]353 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
354 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
355 {
356 "message": "A String", # [Output Only] An optional, human-readable error message.
357 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]358 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]359 },
360 ],
361 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]362 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]363 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]364 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]365 }</pre>
366</div>
367
368<div class="method">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]369 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]370 <pre>Retrieves a list of VpnTunnel resources contained in the specified project and region.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]371
372Args:
373 project: string, Project ID for this request. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]374 region: string, Name of the region for this request. (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]375 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
376
377You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
378
379Currently, only sorting by name or creationTimestamp desc is supported.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]380 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
381 pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
382 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]383
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]384The 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 you are filtering by (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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]385
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]386For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]387
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]388You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]389
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]390To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]391
392Returns:
393 An object of the form:
394
395 { # Contains a list of VpnTunnel resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]396 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]397 "items": [ # [Output Only] A list of VpnTunnel resources.
398 {
399 "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
400 "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.
401 "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]402 "remoteTrafficSelector": [ # Remote traffic selectors 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.
403 "A String",
404 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]405 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]406 "peerIp": "A String", # IP address of the peer VPN gateway.
407 "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]408 "localTrafficSelector": [ # Local traffic selector 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.
409 "A String",
410 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]411 "targetVpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]412 "status": "A String", # [Output Only] The status of the VPN tunnel.
413 "sharedSecretHash": "A String", # Hash of the shared secret.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]414 "router": "A String", # URL of router resource to be used for dynamic routing.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]415 "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]416 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]417 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]418 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]419 "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]420 },
421 ],
422 "kind": "compute#vpnTunnelList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]423 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame^]424 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]425 }</pre>
426</div>
427
428<div class="method">
429 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
430 <pre>Retrieves the next page of results.
431
432Args:
433 previous_request: The request for the previous page. (required)
434 previous_response: The response from the request for the previous page. (required)
435
436Returns:
437 A request object that you can call 'execute()' on to request the next
438 page. Returns None if there are no more items in the collection.
439 </pre>
440</div>
441
442</body></html>