Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 43fc0cf47ac1b1e90cd52422bc5abdbbf1a8e456 / . / docs / dyn / compute_v1.vpnTunnels.html
blob: 3e590990690649576b312668ba8f0916a5351180 [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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]84 <code><a href="#delete">delete(project, region, vpnTunnel, requestId=None)</a></code></p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="firstline">Returns the specified VpnTunnel resource. Gets 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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]90 <code><a href="#insert">insert(project, region, body, requestId=None)</a></code></p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[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. Acceptable values are 0 to 500, inclusive. (Default: 500)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]113
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]114For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]115
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]117
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]118To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]119
120Returns:
121 An object of the form:
122
123 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]124 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]125 "kind": "compute#vpnTunnelAggregatedList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
126 "items": { # A list of VpnTunnelsScopedList resources.
127 "a_key": { # Name of the scope containing this set of VPN tunnels.
128 "vpnTunnels": [ # A list of VPN tunnels contained in this scope.
129 { # Represents a Cloud VPN Tunnel resource.
130 #
131 # For more information about VPN, read the the Cloud VPN Overview. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]132 "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]133 "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]134 "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]135 "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]136 "A String",
137 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]138 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]139 "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]140 "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
141 "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]142 "A String",
143 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]144 "targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
145 "status": "A String", # [Output Only] The status of the VPN tunnel, which can be one of the following:
146 # - PROVISIONING: Resource is being allocated for the VPN tunnel.
147 # - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel.
148 # - FIRST_HANDSHAKE: Successful first handshake with the peer VPN.
149 # - ESTABLISHED: Secure session is successfully established with the peer VPN.
150 # - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS
151 # - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret).
152 # - NEGOTIATION_FAILURE: Handshake failed.
153 # - DEPROVISIONING: Resources are being deallocated for the VPN tunnel.
154 # - FAILED: Tunnel creation has failed and the tunnel is not ready to be used.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]155 "sharedSecretHash": "A String", # Hash of the shared secret.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]156 "router": "A String", # URL of the router resource to be used for dynamic routing.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]157 "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]158 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]159 "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]160 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]161 "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]162 },
163 ],
164 "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]165 "message": "A String", # [Output Only] A human-readable description of the warning code.
166 "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.
167 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
168 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]169 {
170 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]171 "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]172 },
173 ],
174 },
175 },
176 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]177 "warning": { # [Output Only] Informational warning message.
178 "message": "A String", # [Output Only] A human-readable description of the warning code.
179 "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.
180 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
181 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
182 {
183 "value": "A String", # [Output Only] A warning data value corresponding to the key.
184 "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).
185 },
186 ],
187 },
188 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]189 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]190 }</pre>
191</div>
192
193<div class="method">
194 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
195 <pre>Retrieves the next page of results.
196
197Args:
198 previous_request: The request for the previous page. (required)
199 previous_response: The response from the request for the previous page. (required)
200
201Returns:
202 A request object that you can call 'execute()' on to request the next
203 page. Returns None if there are no more items in the collection.
204 </pre>
205</div>
206
207<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]208 <code class="details" id="delete">delete(project, region, vpnTunnel, requestId=None)</code>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]209 <pre>Deletes the specified VpnTunnel resource.
210
211Args:
212 project: string, Project ID for this request. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]213 region: string, Name of the region for this request. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]214 vpnTunnel: string, Name of the VpnTunnel resource to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]215 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
216
217For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
218
219The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]220
221Returns:
222 An object of the form:
223
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]224 { # Represents an Operation resource.
225 #
226 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
227 #
228 # Operations can be global, regional or zonal.
229 # - For global operations, use the globalOperations resource.
230 # - For regional operations, use the regionOperations resource.
231 # - For zonal operations, use the zonalOperations resource.
232 #
233 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]234 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]235 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]236 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]237 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]238 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]239 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
240 "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]241 "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]242 "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.
243 "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]244 "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]245 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
246 "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]247 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
248 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]249 "message": "A String", # [Output Only] A human-readable description of the warning code.
250 "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.
251 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
252 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]253 {
254 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]255 "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]256 },
257 ],
258 },
259 ],
260 "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]261 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
262 "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]263 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]264 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]265 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
266 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
267 {
268 "message": "A String", # [Output Only] An optional, human-readable error message.
269 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]270 "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]271 },
272 ],
273 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]274 "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]275 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]276 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]277 }</pre>
278</div>
279
280<div class="method">
281 <code class="details" id="get">get(project, region, vpnTunnel)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]282 <pre>Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]283
284Args:
285 project: string, Project ID for this request. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]286 region: string, Name of the region for this request. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]287 vpnTunnel: string, Name of the VpnTunnel resource to return. (required)
288
289Returns:
290 An object of the form:
291
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]292 { # Represents a Cloud VPN Tunnel resource.
293 #
294 # For more information about VPN, read the the Cloud VPN Overview. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]295 "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]296 "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]297 "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]298 "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]299 "A String",
300 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]301 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]302 "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]303 "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
304 "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]305 "A String",
306 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]307 "targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
308 "status": "A String", # [Output Only] The status of the VPN tunnel, which can be one of the following:
309 # - PROVISIONING: Resource is being allocated for the VPN tunnel.
310 # - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel.
311 # - FIRST_HANDSHAKE: Successful first handshake with the peer VPN.
312 # - ESTABLISHED: Secure session is successfully established with the peer VPN.
313 # - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS
314 # - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret).
315 # - NEGOTIATION_FAILURE: Handshake failed.
316 # - DEPROVISIONING: Resources are being deallocated for the VPN tunnel.
317 # - FAILED: Tunnel creation has failed and the tunnel is not ready to be used.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]318 "sharedSecretHash": "A String", # Hash of the shared secret.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]319 "router": "A String", # URL of the router resource to be used for dynamic routing.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]320 "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]321 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]322 "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]323 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]324 "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]325 }</pre>
326</div>
327
328<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]329 <code class="details" id="insert">insert(project, region, body, requestId=None)</code>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]330 <pre>Creates a VpnTunnel resource in the specified project and region using the data included in the request.
331
332Args:
333 project: string, Project ID for this request. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]334 region: string, Name of the region for this request. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]335 body: object, The request body. (required)
336 The object takes the form of:
337
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]338{ # Represents a Cloud VPN Tunnel resource.
339 #
340 # For more information about VPN, read the the Cloud VPN Overview. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]341 "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]342 "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]343 "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]344 "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]345 "A String",
346 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]347 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]348 "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]349 "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
350 "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]351 "A String",
352 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]353 "targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
354 "status": "A String", # [Output Only] The status of the VPN tunnel, which can be one of the following:
355 # - PROVISIONING: Resource is being allocated for the VPN tunnel.
356 # - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel.
357 # - FIRST_HANDSHAKE: Successful first handshake with the peer VPN.
358 # - ESTABLISHED: Secure session is successfully established with the peer VPN.
359 # - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS
360 # - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret).
361 # - NEGOTIATION_FAILURE: Handshake failed.
362 # - DEPROVISIONING: Resources are being deallocated for the VPN tunnel.
363 # - FAILED: Tunnel creation has failed and the tunnel is not ready to be used.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]364 "sharedSecretHash": "A String", # Hash of the shared secret.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]365 "router": "A String", # URL of the router resource to be used for dynamic routing.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]366 "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]367 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]368 "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]369 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]370 "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]371 }
372
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]373 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
374
375For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
376
377The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]378
379Returns:
380 An object of the form:
381
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]382 { # Represents an Operation resource.
383 #
384 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
385 #
386 # Operations can be global, regional or zonal.
387 # - For global operations, use the globalOperations resource.
388 # - For regional operations, use the regionOperations resource.
389 # - For zonal operations, use the zonalOperations resource.
390 #
391 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]392 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]393 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]394 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]395 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]396 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]397 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
398 "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]399 "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]400 "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.
401 "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]402 "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]403 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
404 "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]405 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
406 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]407 "message": "A String", # [Output Only] A human-readable description of the warning code.
408 "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.
409 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
410 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]411 {
412 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]413 "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]414 },
415 ],
416 },
417 ],
418 "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]419 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
420 "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]421 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]422 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]423 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
424 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
425 {
426 "message": "A String", # [Output Only] An optional, human-readable error message.
427 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]428 "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]429 },
430 ],
431 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]432 "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]433 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]434 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]435 }</pre>
436</div>
437
438<div class="method">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]439 <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]440 <pre>Retrieves a list of VpnTunnel resources contained in the specified project and region.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]441
442Args:
443 project: string, Project ID for this request. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]444 region: string, Name of the region for this request. (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]445 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
446
447You 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.
448
449Currently, only sorting by name or creationTimestamp desc is supported.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]450 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. Acceptable values are 0 to 500, inclusive. (Default: 500)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]451 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]452 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]453
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]454For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]455
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]456You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]457
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]458To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]459
460Returns:
461 An object of the form:
462
463 { # Contains a list of VpnTunnel resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]464 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]465 "kind": "compute#vpnTunnelList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
466 "items": [ # A list of VpnTunnel resources.
467 { # Represents a Cloud VPN Tunnel resource.
468 #
469 # For more information about VPN, read the the Cloud VPN Overview. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]470 "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]471 "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]472 "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]473 "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]474 "A String",
475 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]476 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]477 "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]478 "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
479 "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]480 "A String",
481 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]482 "targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
483 "status": "A String", # [Output Only] The status of the VPN tunnel, which can be one of the following:
484 # - PROVISIONING: Resource is being allocated for the VPN tunnel.
485 # - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel.
486 # - FIRST_HANDSHAKE: Successful first handshake with the peer VPN.
487 # - ESTABLISHED: Secure session is successfully established with the peer VPN.
488 # - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS
489 # - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret).
490 # - NEGOTIATION_FAILURE: Handshake failed.
491 # - DEPROVISIONING: Resources are being deallocated for the VPN tunnel.
492 # - FAILED: Tunnel creation has failed and the tunnel is not ready to be used.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]493 "sharedSecretHash": "A String", # Hash of the shared secret.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]494 "router": "A String", # URL of the router resource to be used for dynamic routing.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]495 "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]496 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]497 "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]498 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]499 "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]500 },
501 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]502 "warning": { # [Output Only] Informational warning message.
503 "message": "A String", # [Output Only] A human-readable description of the warning code.
504 "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.
505 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
506 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
507 {
508 "value": "A String", # [Output Only] A warning data value corresponding to the key.
509 "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).
510 },
511 ],
512 },
513 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]514 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]515 }</pre>
516</div>
517
518<div class="method">
519 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
520 <pre>Retrieves the next page of results.
521
522Args:
523 previous_request: The request for the previous page. (required)
524 previous_response: The response from the request for the previous page. (required)
525
526Returns:
527 A request object that you can call 'execute()' on to request the next
528 page. Returns None if there are no more items in the collection.
529 </pre>
530</div>
531
532</body></html>