Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 860a6378c538d8e2e424c7be150b41ba28120387 / . / docs / dyn / compute_beta.routers.html
blob: 487170dd2f33b43b8eae76b76a7e670e0b4db0d5 [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[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_beta.html">Compute Engine API</a> . <a href="compute_beta.routers.html">routers</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
79<p class="firstline">Retrieves an aggregated list of routers.</p>
80<p class="toc_element">
81 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(project, region, router)</a></code></p>
85<p class="firstline">Deletes the specified Router resource.</p>
86<p class="toc_element">
87 <code><a href="#get">get(project, region, router)</a></code></p>
88<p class="firstline">Returns the specified Router resource. Get a list of available routers by making a list() request.</p>
89<p class="toc_element">
90 <code><a href="#getRouterStatus">getRouterStatus(project, region, router)</a></code></p>
91<p class="firstline">Retrieves runtime information of the specified router.</p>
92<p class="toc_element">
93 <code><a href="#insert">insert(project, region, body)</a></code></p>
94<p class="firstline">Creates a Router resource in the specified project and region using the data included in the request.</p>
95<p class="toc_element">
96 <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
97<p class="firstline">Retrieves a list of Router resources available to the specified project.</p>
98<p class="toc_element">
99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
102 <code><a href="#patch">patch(project, region, router, body)</a></code></p>
103<p class="firstline">Updates the specified Router resource with the data included in the request. This method supports patch semantics.</p>
104<p class="toc_element">
105 <code><a href="#preview">preview(project, region, router, body)</a></code></p>
106<p class="firstline">Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.</p>
107<p class="toc_element">
108 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
109<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
110<p class="toc_element">
111 <code><a href="#update">update(project, region, router, body)</a></code></p>
112<p class="firstline">Updates the specified Router resource with the data included in the request.</p>
113<h3>Method Details</h3>
114<div class="method">
115 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
116 <pre>Retrieves an aggregated list of routers.
117
118Args:
119 project: string, Project ID for this request. (required)
120 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
121
122You 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.
123
124Currently, only sorting by name or creationTimestamp desc is supported.
125 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.
126 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.
127 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.
128
129The 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.
130
131For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
132
133You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
134
135To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
136
137Returns:
138 An object of the form:
139
140 { # Contains a list of routers.
141 "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.
142 "items": { # A map of scoped router lists.
143 "a_key": { # Name of the scope containing this set of routers.
144 "routers": [ # List of routers contained in this scope.
145 { # Router resource.
146 "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
147 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
148 "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
149 {
150 "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
151 "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
152 "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
153 },
154 ],
155 "bgp": { # BGP information specific to this router.
156 "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
157 },
158 "network": "A String", # URI of the network to which this router belongs.
159 "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
160 {
161 "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
162 "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
163 "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
164 "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
165 "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
166 "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
167 },
168 ],
169 "region": "A String", # [Output Only] URI of the region where the router resides.
170 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
171 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
172 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
173 "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.
174 },
175 ],
176 "warning": { # Informational warning which replaces the list of routers when the list is empty.
177 "message": "A String", # [Output Only] A human-readable description of the warning code.
178 "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.
179 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
180 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
181 {
182 "value": "A String", # [Output Only] A warning data value corresponding to the key.
183 "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).
184 },
185 ],
186 },
187 },
188 },
189 "kind": "compute#routerAggregatedList", # Type of resource.
190 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
191 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
192 }</pre>
193</div>
194
195<div class="method">
196 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
197 <pre>Retrieves the next page of results.
198
199Args:
200 previous_request: The request for the previous page. (required)
201 previous_response: The response from the request for the previous page. (required)
202
203Returns:
204 A request object that you can call 'execute()' on to request the next
205 page. Returns None if there are no more items in the collection.
206 </pre>
207</div>
208
209<div class="method">
210 <code class="details" id="delete">delete(project, region, router)</code>
211 <pre>Deletes the specified Router resource.
212
213Args:
214 project: string, Project ID for this request. (required)
215 region: string, Name of the region for this request. (required)
216 router: string, Name of the Router resource to delete. (required)
217
218Returns:
219 An object of the form:
220
221 { # An Operation resource, used to manage asynchronous API requests.
222 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
223 "clientOperationId": "A String", # [Output Only] Reserved for future use.
224 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
225 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
226 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
227 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
228 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
229 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
230 "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.
231 "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.
232 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
233 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
234 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
235 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
236 {
237 "message": "A String", # [Output Only] A human-readable description of the warning code.
238 "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.
239 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
240 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
241 {
242 "value": "A String", # [Output Only] A warning data value corresponding to the key.
243 "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).
244 },
245 ],
246 },
247 ],
248 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
249 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
250 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
251 "name": "A String", # [Output Only] Name of the resource.
252 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
253 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
254 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
255 {
256 "message": "A String", # [Output Only] An optional, human-readable error message.
257 "code": "A String", # [Output Only] The error type identifier for this error.
258 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
259 },
260 ],
261 },
262 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
263 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]264 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]265 }</pre>
266</div>
267
268<div class="method">
269 <code class="details" id="get">get(project, region, router)</code>
270 <pre>Returns the specified Router resource. Get a list of available routers by making a list() request.
271
272Args:
273 project: string, Project ID for this request. (required)
274 region: string, Name of the region for this request. (required)
275 router: string, Name of the Router resource to return. (required)
276
277Returns:
278 An object of the form:
279
280 { # Router resource.
281 "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
282 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
283 "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
284 {
285 "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
286 "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
287 "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
288 },
289 ],
290 "bgp": { # BGP information specific to this router.
291 "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
292 },
293 "network": "A String", # URI of the network to which this router belongs.
294 "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
295 {
296 "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
297 "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
298 "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
299 "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
300 "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
301 "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
302 },
303 ],
304 "region": "A String", # [Output Only] URI of the region where the router resides.
305 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
306 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
307 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
308 "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.
309 }</pre>
310</div>
311
312<div class="method">
313 <code class="details" id="getRouterStatus">getRouterStatus(project, region, router)</code>
314 <pre>Retrieves runtime information of the specified router.
315
316Args:
317 project: string, Project ID for this request. (required)
318 region: string, Name of the region for this request. (required)
319 router: string, Name of the Router resource to query. (required)
320
321Returns:
322 An object of the form:
323
324 {
325 "kind": "compute#routerStatusResponse", # Type of resource.
326 "result": {
327 "bgpPeerStatus": [
328 {
329 "status": "A String", # Status of the BGP peer: {UP, DOWN}
330 "uptime": "A String", # Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds
331 "name": "A String", # Name of this BGP peer. Unique within the Routers resource.
332 "uptimeSeconds": "A String", # Time this session has been up, in seconds. Format: 145
333 "linkedVpnTunnel": "A String", # URL of the VPN tunnel that this BGP peer controls.
334 "peerIpAddress": "A String", # IP address of the remote BGP interface.
335 "advertisedRoutes": [ # Routes that were advertised to the remote BGP peer
336 { # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
337 #
338 # For each packet leaving a instance, the system searches that instance's routing table for a single best matching route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching routes. The packet is then forwarded as specified by the nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
339 #
340 # Packets that do not match any route in the sending instance's routing table are dropped.
341 "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/<project-id>/global/gateways/default-internet-gateway
342 "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
343 "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
344 "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.
345 "tags": [ # A list of instance tags to which this route applies.
346 "A String",
347 ],
348 "nextHopInstance": "A String", # The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example:
349 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
350 "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
351 "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
352 "network": "A String", # Fully-qualified URL of the network that this route applies to.
353 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
354 "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
355 {
356 "message": "A String", # [Output Only] A human-readable description of the warning code.
357 "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.
358 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
359 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
360 {
361 "value": "A String", # [Output Only] A warning data value corresponding to the key.
362 "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).
363 },
364 ],
365 },
366 ],
367 "destRange": "A String", # The destination range of outgoing packets that this route applies to.
368 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
369 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
370 "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
371 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
372 },
373 ],
374 "state": "A String", # BGP state as specified in RFC1771.
375 "ipAddress": "A String", # IP address of the local BGP interface.
376 "numLearnedRoutes": 42, # Number of routes learned from the remote BGP Peer.
377 },
378 ],
379 "network": "A String", # URI of the network to which this router belongs.
380 "bestRoutes": [ # Best routes for this router's network.
381 { # Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
382 #
383 # For each packet leaving a instance, the system searches that instance's routing table for a single best matching route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching routes. The packet is then forwarded as specified by the nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
384 #
385 # Packets that do not match any route in the sending instance's routing table are dropped.
386 "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/<project-id>/global/gateways/default-internet-gateway
387 "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
388 "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
389 "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.
390 "tags": [ # A list of instance tags to which this route applies.
391 "A String",
392 ],
393 "nextHopInstance": "A String", # The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example:
394 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
395 "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
396 "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
397 "network": "A String", # Fully-qualified URL of the network that this route applies to.
398 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
399 "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
400 {
401 "message": "A String", # [Output Only] A human-readable description of the warning code.
402 "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.
403 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
404 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
405 {
406 "value": "A String", # [Output Only] A warning data value corresponding to the key.
407 "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).
408 },
409 ],
410 },
411 ],
412 "destRange": "A String", # The destination range of outgoing packets that this route applies to.
413 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
414 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
415 "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
416 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
417 },
418 ],
419 },
420 }</pre>
421</div>
422
423<div class="method">
424 <code class="details" id="insert">insert(project, region, body)</code>
425 <pre>Creates a Router resource in the specified project and region using the data included in the request.
426
427Args:
428 project: string, Project ID for this request. (required)
429 region: string, Name of the region for this request. (required)
430 body: object, The request body. (required)
431 The object takes the form of:
432
433{ # Router resource.
434 "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
435 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
436 "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
437 {
438 "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
439 "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
440 "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
441 },
442 ],
443 "bgp": { # BGP information specific to this router.
444 "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
445 },
446 "network": "A String", # URI of the network to which this router belongs.
447 "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
448 {
449 "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
450 "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
451 "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
452 "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
453 "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
454 "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
455 },
456 ],
457 "region": "A String", # [Output Only] URI of the region where the router resides.
458 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
459 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
460 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
461 "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.
462 }
463
464
465Returns:
466 An object of the form:
467
468 { # An Operation resource, used to manage asynchronous API requests.
469 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
470 "clientOperationId": "A String", # [Output Only] Reserved for future use.
471 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
472 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
473 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
474 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
475 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
476 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
477 "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.
478 "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.
479 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
480 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
481 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
482 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
483 {
484 "message": "A String", # [Output Only] A human-readable description of the warning code.
485 "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.
486 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
487 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
488 {
489 "value": "A String", # [Output Only] A warning data value corresponding to the key.
490 "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).
491 },
492 ],
493 },
494 ],
495 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
496 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
497 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
498 "name": "A String", # [Output Only] Name of the resource.
499 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
500 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
501 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
502 {
503 "message": "A String", # [Output Only] An optional, human-readable error message.
504 "code": "A String", # [Output Only] The error type identifier for this error.
505 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
506 },
507 ],
508 },
509 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
510 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]511 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]512 }</pre>
513</div>
514
515<div class="method">
516 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
517 <pre>Retrieves a list of Router resources available to the specified project.
518
519Args:
520 project: string, Project ID for this request. (required)
521 region: string, Name of the region for this request. (required)
522 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
523
524You 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.
525
526Currently, only sorting by name or creationTimestamp desc is supported.
527 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.
528 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.
529 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.
530
531The 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.
532
533For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
534
535You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
536
537To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
538
539Returns:
540 An object of the form:
541
542 { # Contains a list of Router resources.
543 "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.
544 "items": [ # A list of Router resources.
545 { # Router resource.
546 "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
547 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
548 "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
549 {
550 "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
551 "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
552 "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
553 },
554 ],
555 "bgp": { # BGP information specific to this router.
556 "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
557 },
558 "network": "A String", # URI of the network to which this router belongs.
559 "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
560 {
561 "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
562 "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
563 "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
564 "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
565 "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
566 "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
567 },
568 ],
569 "region": "A String", # [Output Only] URI of the region where the router resides.
570 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
571 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
572 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
573 "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.
574 },
575 ],
576 "kind": "compute#routerList", # [Output Only] Type of resource. Always compute#router for routers.
577 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
578 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
579 }</pre>
580</div>
581
582<div class="method">
583 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
584 <pre>Retrieves the next page of results.
585
586Args:
587 previous_request: The request for the previous page. (required)
588 previous_response: The response from the request for the previous page. (required)
589
590Returns:
591 A request object that you can call 'execute()' on to request the next
592 page. Returns None if there are no more items in the collection.
593 </pre>
594</div>
595
596<div class="method">
597 <code class="details" id="patch">patch(project, region, router, body)</code>
598 <pre>Updates the specified Router resource with the data included in the request. This method supports patch semantics.
599
600Args:
601 project: string, Project ID for this request. (required)
602 region: string, Name of the region for this request. (required)
603 router: string, Name of the Router resource to update. (required)
604 body: object, The request body. (required)
605 The object takes the form of:
606
607{ # Router resource.
608 "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
609 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
610 "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
611 {
612 "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
613 "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
614 "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
615 },
616 ],
617 "bgp": { # BGP information specific to this router.
618 "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
619 },
620 "network": "A String", # URI of the network to which this router belongs.
621 "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
622 {
623 "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
624 "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
625 "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
626 "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
627 "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
628 "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
629 },
630 ],
631 "region": "A String", # [Output Only] URI of the region where the router resides.
632 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
633 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
634 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
635 "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.
636 }
637
638
639Returns:
640 An object of the form:
641
642 { # An Operation resource, used to manage asynchronous API requests.
643 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
644 "clientOperationId": "A String", # [Output Only] Reserved for future use.
645 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
646 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
647 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
648 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
649 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
650 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
651 "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.
652 "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.
653 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
654 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
655 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
656 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
657 {
658 "message": "A String", # [Output Only] A human-readable description of the warning code.
659 "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.
660 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
661 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
662 {
663 "value": "A String", # [Output Only] A warning data value corresponding to the key.
664 "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).
665 },
666 ],
667 },
668 ],
669 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
670 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
671 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
672 "name": "A String", # [Output Only] Name of the resource.
673 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
674 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
675 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
676 {
677 "message": "A String", # [Output Only] An optional, human-readable error message.
678 "code": "A String", # [Output Only] The error type identifier for this error.
679 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
680 },
681 ],
682 },
683 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
684 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]685 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]686 }</pre>
687</div>
688
689<div class="method">
690 <code class="details" id="preview">preview(project, region, router, body)</code>
691 <pre>Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.
692
693Args:
694 project: string, Project ID for this request. (required)
695 region: string, Name of the region for this request. (required)
696 router: string, Name of the Router resource to query. (required)
697 body: object, The request body. (required)
698 The object takes the form of:
699
700{ # Router resource.
701 "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
702 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
703 "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
704 {
705 "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
706 "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
707 "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
708 },
709 ],
710 "bgp": { # BGP information specific to this router.
711 "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
712 },
713 "network": "A String", # URI of the network to which this router belongs.
714 "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
715 {
716 "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
717 "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
718 "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
719 "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
720 "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
721 "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
722 },
723 ],
724 "region": "A String", # [Output Only] URI of the region where the router resides.
725 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
726 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
727 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
728 "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.
729 }
730
731
732Returns:
733 An object of the form:
734
735 {
736 "resource": { # Router resource. # Preview of given router.
737 "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
738 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
739 "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
740 {
741 "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
742 "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
743 "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
744 },
745 ],
746 "bgp": { # BGP information specific to this router.
747 "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
748 },
749 "network": "A String", # URI of the network to which this router belongs.
750 "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
751 {
752 "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
753 "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
754 "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
755 "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
756 "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
757 "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
758 },
759 ],
760 "region": "A String", # [Output Only] URI of the region where the router resides.
761 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
762 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
763 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
764 "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.
765 },
766 }</pre>
767</div>
768
769<div class="method">
770 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
771 <pre>Returns permissions that a caller has on the specified resource.
772
773Args:
774 project: string, Project ID for this request. (required)
775 region: string, The name of the region for this request. (required)
776 resource: string, Name of the resource for this request. (required)
777 body: object, The request body. (required)
778 The object takes the form of:
779
780{
781 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
782 "A String",
783 ],
784 }
785
786
787Returns:
788 An object of the form:
789
790 {
791 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
792 "A String",
793 ],
794 }</pre>
795</div>
796
797<div class="method">
798 <code class="details" id="update">update(project, region, router, body)</code>
799 <pre>Updates the specified Router resource with the data included in the request.
800
801Args:
802 project: string, Project ID for this request. (required)
803 region: string, Name of the region for this request. (required)
804 router: string, Name of the Router resource to update. (required)
805 body: object, The request body. (required)
806 The object takes the form of:
807
808{ # Router resource.
809 "kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.
810 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
811 "interfaces": [ # Router interfaces. Each interface requires either one linked resource (e.g. linkedVpnTunnel), or IP address and IP address range (e.g. ipRange), or both.
812 {
813 "linkedVpnTunnel": "A String", # URI of linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource.
814 "ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.
815 "name": "A String", # Name of this interface entry. The name must be 1-63 characters long and comply with RFC1035.
816 },
817 ],
818 "bgp": { # BGP information specific to this router.
819 "asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.
820 },
821 "network": "A String", # URI of the network to which this router belongs.
822 "bgpPeers": [ # BGP information that needs to be configured into the routing stack to establish the BGP peering. It must specify peer ASN and either interface name, IP, or peer IP. Please refer to RFC4273.
823 {
824 "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
825 "peerIpAddress": "A String", # IP address of the BGP interface outside Google cloud.
826 "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). For VPN use case, this value can be different for every tunnel.
827 "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. In the case where there is more than one matching route of maximum length, the routes with lowest priority value win.
828 "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
829 "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long and comply with RFC1035.
830 },
831 ],
832 "region": "A String", # [Output Only] URI of the region where the router resides.
833 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
834 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
835 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
836 "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.
837 }
838
839
840Returns:
841 An object of the form:
842
843 { # An Operation resource, used to manage asynchronous API requests.
844 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
845 "clientOperationId": "A String", # [Output Only] Reserved for future use.
846 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
847 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
848 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
849 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
850 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
851 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
852 "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.
853 "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.
854 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
855 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
856 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
857 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
858 {
859 "message": "A String", # [Output Only] A human-readable description of the warning code.
860 "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.
861 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
862 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
863 {
864 "value": "A String", # [Output Only] A warning data value corresponding to the key.
865 "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).
866 },
867 ],
868 },
869 ],
870 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
871 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
872 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
873 "name": "A String", # [Output Only] Name of the resource.
874 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
875 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
876 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
877 {
878 "message": "A String", # [Output Only] An optional, human-readable error message.
879 "code": "A String", # [Output Only] The error type identifier for this error.
880 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
881 },
882 ],
883 },
884 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
885 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]886 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]887 }</pre>
888</div>
889
890</body></html>