Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0a471d3d1d3c16eeda1d1a1288f99be9f8027475 / . / docs / dyn / compute_v1.targetVpnGateways.html
blob: 603fdcca5d11a0a6ddac7bbb229fec027ea51996 [file] [log] [blame]
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.targetVpnGateways.html">targetVpnGateways</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]79<p class="firstline">Retrieves an aggregated list of target VPN gateways.</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, targetVpnGateway)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]85<p class="firstline">Deletes the specified target VPN gateway.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]86<p class="toc_element">
87 <code><a href="#get">get(project, region, targetVpnGateway)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]88<p class="firstline">Returns the specified target VPN gateway. Get a list of available target VPN gateways 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>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]91<p class="firstline">Creates a target VPN gateway in the specified project and region using the data included in the request.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]92<p class="toc_element">
93 <code><a href="#list">list(project, region, 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 target VPN gateways available to 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">
100 <code class="details" id="aggregatedList">aggregatedList(project, 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 target VPN gateways.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]102
103Args:
104 project: string, Project ID for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]105 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.
106 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.
107 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]108
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]109The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field 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]110
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]111For 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]112
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]113Compute Engine Beta API Only: When filtering in the Beta API, you can also 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]114
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]115The Beta API also supports filtering on multiple expressions by providing 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]116
117Returns:
118 An object of the form:
119
120 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]121 "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]122 "items": { # A map of scoped target vpn gateway lists.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]123 "a_key": { # [Output Only] Name of the scope containing this set of target VPN gateways.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]124 "targetVpnGateways": [ # [Output Only] List of target vpn gateways contained in this scope.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]125 { # Represents a Target VPN gateway resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]126 "status": "A String", # [Output Only] The status of the VPN gateway.
127 "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]128 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
129 "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]130 "A String",
131 ],
132 "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
133 "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
134 "A String",
135 ],
136 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
137 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]138 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]139 "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]140 "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]141 },
142 ],
143 "warning": { # [Output Only] Informational warning which replaces the list of addresses when the list is empty.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]144 "message": "A String", # [Output Only] A human-readable description of the warning code.
145 "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.
146 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
147 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]148 {
149 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]150 "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]151 },
152 ],
153 },
154 },
155 },
156 "kind": "compute#targetVpnGatewayAggregatedList", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]157 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]158 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
159 }</pre>
160</div>
161
162<div class="method">
163 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
164 <pre>Retrieves the next page of results.
165
166Args:
167 previous_request: The request for the previous page. (required)
168 previous_response: The response from the request for the previous page. (required)
169
170Returns:
171 A request object that you can call 'execute()' on to request the next
172 page. Returns None if there are no more items in the collection.
173 </pre>
174</div>
175
176<div class="method">
177 <code class="details" id="delete">delete(project, region, targetVpnGateway)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]178 <pre>Deletes the specified target VPN gateway.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]179
180Args:
181 project: string, Project ID for this request. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]182 region: string, Name of the region for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]183 targetVpnGateway: string, Name of the target VPN gateway to delete. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]184
185Returns:
186 An object of the form:
187
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]188 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]189 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
190 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]191 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]192 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
193 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
194 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
195 "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]196 "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]197 "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.
198 "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]199 "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]200 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
201 "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]202 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
203 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]204 "message": "A String", # [Output Only] A human-readable description of the warning code.
205 "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.
206 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
207 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]208 {
209 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]210 "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]211 },
212 ],
213 },
214 ],
215 "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]216 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
217 "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]218 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]219 "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]220 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
221 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
222 {
223 "message": "A String", # [Output Only] An optional, human-readable error message.
224 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]225 "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]226 },
227 ],
228 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]229 "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]230 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]231 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]232 }</pre>
233</div>
234
235<div class="method">
236 <code class="details" id="get">get(project, region, targetVpnGateway)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]237 <pre>Returns the specified target VPN gateway. Get a list of available target VPN gateways by making a list() request.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]238
239Args:
240 project: string, Project ID for this request. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]241 region: string, Name of the region for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]242 targetVpnGateway: string, Name of the target VPN gateway to return. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]243
244Returns:
245 An object of the form:
246
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]247 { # Represents a Target VPN gateway resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]248 "status": "A String", # [Output Only] The status of the VPN gateway.
249 "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]250 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
251 "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]252 "A String",
253 ],
254 "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
255 "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
256 "A String",
257 ],
258 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
259 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]260 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]261 "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]262 "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]263 }</pre>
264</div>
265
266<div class="method">
267 <code class="details" id="insert">insert(project, region, body)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]268 <pre>Creates a target VPN gateway in the specified project and region using the data included in the request.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]269
270Args:
271 project: string, Project ID for this request. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]272 region: string, Name of the region for this request. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]273 body: object, The request body. (required)
274 The object takes the form of:
275
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]276{ # Represents a Target VPN gateway resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]277 "status": "A String", # [Output Only] The status of the VPN gateway.
278 "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]279 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
280 "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]281 "A String",
282 ],
283 "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
284 "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
285 "A String",
286 ],
287 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
288 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]289 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]290 "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]291 "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]292 }
293
294
295Returns:
296 An object of the form:
297
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]298 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]299 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
300 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]301 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]302 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
303 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
304 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
305 "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]306 "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]307 "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.
308 "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]309 "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]310 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
311 "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]312 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
313 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]314 "message": "A String", # [Output Only] A human-readable description of the warning code.
315 "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.
316 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
317 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]318 {
319 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]320 "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]321 },
322 ],
323 },
324 ],
325 "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]326 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
327 "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]328 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]329 "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]330 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
331 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
332 {
333 "message": "A String", # [Output Only] An optional, human-readable error message.
334 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]335 "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]336 },
337 ],
338 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]339 "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]340 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]341 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]342 }</pre>
343</div>
344
345<div class="method">
346 <code class="details" id="list">list(project, region, maxResults=None, pageToken=None, filter=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]347 <pre>Retrieves a list of target VPN gateways available to the specified project and region.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]348
349Args:
350 project: string, Project ID for this request. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]351 region: string, Name of the region for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]352 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.
353 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.
354 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]355
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]356The 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]357
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]358For 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]359
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]360Compute Engine Beta API Only: When filtering in the Beta API, you can also 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]361
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]362The Beta API also supports filtering on multiple expressions by providing 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]363
364Returns:
365 An object of the form:
366
367 { # Contains a list of TargetVpnGateway resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]368 "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]369 "items": [ # [Output Only] A list of TargetVpnGateway resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]370 { # Represents a Target VPN gateway resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]371 "status": "A String", # [Output Only] The status of the VPN gateway.
372 "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]373 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
374 "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]375 "A String",
376 ],
377 "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
378 "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.
379 "A String",
380 ],
381 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
382 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]383 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]384 "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]385 "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]386 },
387 ],
388 "kind": "compute#targetVpnGatewayList", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]389 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]390 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
391 }</pre>
392</div>
393
394<div class="method">
395 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
396 <pre>Retrieves the next page of results.
397
398Args:
399 previous_request: The request for the previous page. (required)
400 previous_response: The response from the request for the previous page. (required)
401
402Returns:
403 A request object that you can call 'execute()' on to request the next
404 page. Returns None if there are no more items in the collection.
405 </pre>
406</div>
407
408</body></html>