Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / compute_v1.targetVpnGateways.html
blob: 3f2275e568c515614fa136bf73db1b619386e6de [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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None, includeAllScopes=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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]84 <code><a href="#delete">delete(project, region, targetVpnGateway, requestId=None)</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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="firstline">Returns the specified target VPN gateway. Gets 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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]90 <code><a href="#insert">insert(project, region, body=None, requestId=None)</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">
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 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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]100 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None, includeAllScopes=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)
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
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]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.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]108
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]109Currently, only sorting by `name` or `creationTimestamp desc` is supported.
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`)
111 pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
112 filter: string, 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 `=`, `!=`, `&gt;`, or `&lt;`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]113
Dan O'Mearadd494642020-05-01 07:42:23 -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
Dan O'Mearadd494642020-05-01 07:42:23 -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
Dan O'Mearadd494642020-05-01 07:42:23 -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) ```
119 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]120
121Returns:
122 An object of the form:
123
124 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]125 "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]126 "kind": "compute#targetVpnGatewayAggregatedList", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
127 "items": { # A list of TargetVpnGateway resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]128 "a_key": { # [Output Only] Name of the scope containing this set of target VPN gateways.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]129 "targetVpnGateways": [ # [Output Only] A list of target VPN gateways contained in this scope.
130 { # Represents a Target VPN Gateway resource.
131 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]132 # The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview. (== resource_for {$api_version}.targetVpnGateways ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]133 "status": "A String", # [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]134 "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]135 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136 "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]137 "A String",
138 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]139 "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
140 "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]141 "A String",
142 ],
143 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
144 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]145 "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]146 "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]147 "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]148 },
149 ],
150 "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]151 "message": "A String", # [Output Only] A human-readable description of the warning code.
152 "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.
153 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
154 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]155 {
156 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]157 "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]158 },
159 ],
160 },
161 },
162 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]163 "warning": { # [Output Only] Informational warning message.
164 "message": "A String", # [Output Only] A human-readable description of the warning code.
165 "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.
166 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
167 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
168 {
169 "value": "A String", # [Output Only] A warning data value corresponding to the key.
170 "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).
171 },
172 ],
173 },
174 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]175 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]176 }</pre>
177</div>
178
179<div class="method">
180 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
181 <pre>Retrieves the next page of results.
182
183Args:
184 previous_request: The request for the previous page. (required)
185 previous_response: The response from the request for the previous page. (required)
186
187Returns:
188 A request object that you can call 'execute()' on to request the next
189 page. Returns None if there are no more items in the collection.
190 </pre>
191</div>
192
193<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]194 <code class="details" id="delete">delete(project, region, targetVpnGateway, requestId=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]195 <pre>Deletes the specified target VPN gateway.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]196
197Args:
198 project: string, Project ID for this request. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]199 region: string, Name of the region for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]200 targetVpnGateway: string, Name of the target VPN gateway to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]201 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.
202
203For 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.
204
205The 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]206
207Returns:
208 An object of the form:
209
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]210 { # Represents an Operation resource.
211 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]212 # Google Compute Engine has three Operation resources:
213 #
214 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
215 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]216 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
217 #
218 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]219 # - For global operations, use the `globalOperations` resource.
220 # - For regional operations, use the `regionOperations` resource.
221 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]222 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]223 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]224 "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]225 "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]226 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]227 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]228 "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]229 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]230 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
231 "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]232 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]233 "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]234 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]235 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]236 "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]237 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
238 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]239 "message": "A String", # [Output Only] A human-readable description of the warning code.
240 "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.
241 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
242 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]243 {
244 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]245 "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]246 },
247 ],
248 },
249 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]250 "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]251 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]252 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
253 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]254 "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]255 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
256 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
257 {
258 "message": "A String", # [Output Only] An optional, human-readable error message.
259 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]260 "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]261 },
262 ],
263 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]264 "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]265 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]266 "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]267 }</pre>
268</div>
269
270<div class="method">
271 <code class="details" id="get">get(project, region, targetVpnGateway)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]272 <pre>Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]273
274Args:
275 project: string, Project ID for this request. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]276 region: string, Name of the region for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]277 targetVpnGateway: string, Name of the target VPN gateway to return. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]278
279Returns:
280 An object of the form:
281
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]282 { # Represents a Target VPN Gateway resource.
283 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]284 # The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview. (== resource_for {$api_version}.targetVpnGateways ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]285 "status": "A String", # [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]286 "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]287 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]288 "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]289 "A String",
290 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]291 "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
292 "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]293 "A String",
294 ],
295 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
296 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]297 "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]298 "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]299 "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]300 }</pre>
301</div>
302
303<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]304 <code class="details" id="insert">insert(project, region, body=None, requestId=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]305 <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]306
307Args:
308 project: string, Project ID for this request. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]309 region: string, Name of the region for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]310 body: object, The request body.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]311 The object takes the form of:
312
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]313{ # Represents a Target VPN Gateway resource.
314 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]315 # The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview. (== resource_for {$api_version}.targetVpnGateways ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]316 "status": "A String", # [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]317 "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]318 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]319 "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]320 "A String",
321 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]322 "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
323 "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]324 "A String",
325 ],
326 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
327 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]328 "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]329 "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]330 "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]331 }
332
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]333 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.
334
335For 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.
336
337The 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]338
339Returns:
340 An object of the form:
341
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]342 { # Represents an Operation resource.
343 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]344 # Google Compute Engine has three Operation resources:
345 #
346 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
347 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]348 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
349 #
350 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]351 # - For global operations, use the `globalOperations` resource.
352 # - For regional operations, use the `regionOperations` resource.
353 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]354 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]355 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]356 "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]357 "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]358 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]359 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]360 "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]361 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]362 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
363 "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]364 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]365 "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]366 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]367 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]368 "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]369 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
370 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]371 "message": "A String", # [Output Only] A human-readable description of the warning code.
372 "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.
373 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
374 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]375 {
376 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]377 "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]378 },
379 ],
380 },
381 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]382 "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]383 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]384 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
385 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]386 "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]387 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
388 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
389 {
390 "message": "A String", # [Output Only] An optional, human-readable error message.
391 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]392 "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]393 },
394 ],
395 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]396 "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]397 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]398 "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]399 }</pre>
400</div>
401
402<div class="method">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]403 <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]404 <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]405
406Args:
407 project: string, Project ID for this request. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]408 region: string, Name of the region for this request. (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]409 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
410
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]411You 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.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]412
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]413Currently, only sorting by `name` or `creationTimestamp desc` is supported.
414 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`)
415 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.
416 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 `=`, `!=`, `&gt;`, or `&lt;`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]417
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]418For 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]419
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]420You 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]421
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]422To 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]423
424Returns:
425 An object of the form:
426
427 { # Contains a list of TargetVpnGateway resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]428 "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]429 "kind": "compute#targetVpnGatewayList", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
430 "items": [ # A list of TargetVpnGateway resources.
431 { # Represents a Target VPN Gateway resource.
432 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]433 # The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview. (== resource_for {$api_version}.targetVpnGateways ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]434 "status": "A String", # [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]435 "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]436 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]437 "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]438 "A String",
439 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]440 "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
441 "forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]442 "A String",
443 ],
444 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
445 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]446 "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]447 "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]448 "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]449 },
450 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]451 "warning": { # [Output Only] Informational warning message.
452 "message": "A String", # [Output Only] A human-readable description of the warning code.
453 "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.
454 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
455 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
456 {
457 "value": "A String", # [Output Only] A warning data value corresponding to the key.
458 "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).
459 },
460 ],
461 },
462 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]463 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]464 }</pre>
465</div>
466
467<div class="method">
468 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
469 <pre>Retrieves the next page of results.
470
471Args:
472 previous_request: The request for the previous page. (required)
473 previous_response: The response from the request for the previous page. (required)
474
475Returns:
476 A request object that you can call 'execute()' on to request the next
477 page. Returns None if there are no more items in the collection.
478 </pre>
479</div>
480
481</body></html>