Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0669410c6b2c48884ae31671b9d710a9ff6346c6 / . / docs / dyn / compute_v1.routes.html
blob: ecb577bfff6b992a4f1e0d84fdc0612ed9c16246 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[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.routes.html">routes</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(project, route)</a></code></p>
79<p class="firstline">Deletes the specified route resource.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, route)</a></code></p>
82<p class="firstline">Returns the specified route resource.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(project, body)</a></code></p>
85<p class="firstline">Creates a route resource in the specified project using the data included in the request.</p>
86<p class="toc_element">
87 <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
88<p class="firstline">Retrieves the list of route resources available to the specified project.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="delete">delete(project, route)</code>
95 <pre>Deletes the specified route resource.
96
97Args:
98 project: string, Name of the project scoping this request. (required)
99 route: string, Name of the route resource to delete. (required)
100
101Returns:
102 An object of the form:
103
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]104 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]105 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]106 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]107 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]108 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]109 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
110 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
111 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]112 "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 at when the operation will be complete. This number should monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]113 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]114 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]115 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
116 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
117 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]118 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]119 "message": "A String", # [Output Only] Optional human-readable details for this warning.
120 "code": "A String", # [Output Only] The warning type identifier for this warning.
121 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]122 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]123 "value": "A String", # [Output Only] A warning data value corresponding to the key.
124 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]125 },
126 ],
127 },
128 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]129 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
130 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
131 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
132 "name": "A String", # [Output Only] Name of the resource.
133 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
134 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]135 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]136 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]137 "message": "A String", # [Output Only] An optional, human-readable error message.
138 "code": "A String", # [Output Only] The error type identifier for this error.
139 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]140 },
141 ],
142 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]143 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]144 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]145 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]146 }</pre>
147</div>
148
149<div class="method">
150 <code class="details" id="get">get(project, route)</code>
151 <pre>Returns the specified route resource.
152
153Args:
154 project: string, Name of the project scoping this request. (required)
155 route: string, Name of the route resource to return. (required)
156
157Returns:
158 An object of the form:
159
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]160 { # The route resource. A Route is a rule that specifies how certain packets should be handled by the virtual network. Routes are associated with instances by tag and the set of Routes for a particular instance is called its routing table. 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 Engien-operated gateway. Packets that do not match any Route in the sending instance's routing table are dropped.
161 "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. Currently, this is only the internet gateway: projects/<project-id>/global/gateways/default-internet-gateway
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]162 "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]163 "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
164 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]165 "tags": [ # A list of instance tags to which this route applies.
166 "A String",
167 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]168 "nextHopInstance": "A String", # The fully-qualified URL to an instance that should handle matching packets. For example:
169 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]170 "priority": 42, # Breaks ties between Routes of equal specificity. Routes with smaller values win when tied with routes with larger values. Default value is 1000. A valid range is between 0 and 65535.
171 "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]172 "network": "A String", # Fully-qualified URL of the network that this route applies to.
173 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
174 "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]175 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]176 "message": "A String", # [Output Only] Optional human-readable details for this warning.
177 "code": "A String", # [Output Only] The warning type identifier for this warning.
178 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]179 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]180 "value": "A String", # [Output Only] A warning data value corresponding to the key.
181 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]182 },
183 ],
184 },
185 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]186 "destRange": "A String", # The destination range of outgoing packets that this route applies to.
187 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
188 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]189 "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]190 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]191 }</pre>
192</div>
193
194<div class="method">
195 <code class="details" id="insert">insert(project, body)</code>
196 <pre>Creates a route resource in the specified project using the data included in the request.
197
198Args:
199 project: string, Name of the project scoping this request. (required)
200 body: object, The request body. (required)
201 The object takes the form of:
202
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]203{ # The route resource. A Route is a rule that specifies how certain packets should be handled by the virtual network. Routes are associated with instances by tag and the set of Routes for a particular instance is called its routing table. 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 Engien-operated gateway. Packets that do not match any Route in the sending instance's routing table are dropped.
204 "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. Currently, this is only the internet gateway: projects/<project-id>/global/gateways/default-internet-gateway
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]205 "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]206 "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
207 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]208 "tags": [ # A list of instance tags to which this route applies.
209 "A String",
210 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]211 "nextHopInstance": "A String", # The fully-qualified URL to an instance that should handle matching packets. For example:
212 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]213 "priority": 42, # Breaks ties between Routes of equal specificity. Routes with smaller values win when tied with routes with larger values. Default value is 1000. A valid range is between 0 and 65535.
214 "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]215 "network": "A String", # Fully-qualified URL of the network that this route applies to.
216 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
217 "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]218 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]219 "message": "A String", # [Output Only] Optional human-readable details for this warning.
220 "code": "A String", # [Output Only] The warning type identifier for this warning.
221 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]222 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]223 "value": "A String", # [Output Only] A warning data value corresponding to the key.
224 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]225 },
226 ],
227 },
228 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]229 "destRange": "A String", # The destination range of outgoing packets that this route applies to.
230 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
231 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]232 "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]233 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]234 }
235
236
237Returns:
238 An object of the form:
239
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]240 { # An Operation resource, used to manage asynchronous API requests.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]241 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]242 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]243 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]244 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]245 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
246 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
247 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]248 "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 at when the operation will be complete. This number should monotonically increase as the operation progresses.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]249 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]250 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]251 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
252 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
253 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]254 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]255 "message": "A String", # [Output Only] Optional human-readable details for this warning.
256 "code": "A String", # [Output Only] The warning type identifier for this warning.
257 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]258 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]259 "value": "A String", # [Output Only] A warning data value corresponding to the key.
260 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]261 },
262 ],
263 },
264 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]265 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
266 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
267 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
268 "name": "A String", # [Output Only] Name of the resource.
269 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
270 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]271 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]272 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]273 "message": "A String", # [Output Only] An optional, human-readable error message.
274 "code": "A String", # [Output Only] The error type identifier for this error.
275 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]276 },
277 ],
278 },
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]279 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]280 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]281 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]282 }</pre>
283</div>
284
285<div class="method">
286 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
287 <pre>Retrieves the list of route resources available to the specified project.
288
289Args:
290 project: string, Name of the project scoping this request. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]291 maxResults: integer, Maximum count of results to be returned.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]292 pageToken: string, Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.
293 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.
294
295The 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 (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.
296
297For example, filter=name ne example-instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]298
299Returns:
300 An object of the form:
301
302 { # Contains a list of route resources.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]303 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]304 "items": [ # A list of Route resources.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]305 { # The route resource. A Route is a rule that specifies how certain packets should be handled by the virtual network. Routes are associated with instances by tag and the set of Routes for a particular instance is called its routing table. 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 Engien-operated gateway. Packets that do not match any Route in the sending instance's routing table are dropped.
306 "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. Currently, this is only the internet gateway: projects/<project-id>/global/gateways/default-internet-gateway
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]307 "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]308 "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
309 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]310 "tags": [ # A list of instance tags to which this route applies.
311 "A String",
312 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]313 "nextHopInstance": "A String", # The fully-qualified URL to an instance that should handle matching packets. For example:
314 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]315 "priority": 42, # Breaks ties between Routes of equal specificity. Routes with smaller values win when tied with routes with larger values. Default value is 1000. A valid range is between 0 and 65535.
316 "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]317 "network": "A String", # Fully-qualified URL of the network that this route applies to.
318 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
319 "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]320 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]321 "message": "A String", # [Output Only] Optional human-readable details for this warning.
322 "code": "A String", # [Output Only] The warning type identifier for this warning.
323 "data": [ # [Output Only] Metadata for this warning in key: value format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]324 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]325 "value": "A String", # [Output Only] A warning data value corresponding to the key.
326 "key": "A String", # [Output Only] A key for the warning data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]327 },
328 ],
329 },
330 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]331 "destRange": "A String", # The destination range of outgoing packets that this route applies to.
332 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
333 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]334 "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]335 "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]336 },
337 ],
338 "kind": "compute#routeList", # Type of resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]339 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
340 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]341 }</pre>
342</div>
343
344<div class="method">
345 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
346 <pre>Retrieves the next page of results.
347
348Args:
349 previous_request: The request for the previous page. (required)
350 previous_response: The response from the request for the previous page. (required)
351
352Returns:
353 A request object that you can call 'execute()' on to request the next
354 page. Returns None if there are no more items in the collection.
355 </pre>
356</div>
357
358</body></html>