Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0a471d3d1d3c16eeda1d1a1288f99be9f8027475 / . / docs / dyn / compute_v1.routes.html
blob: 669ed15e7be2f9de861f7b3b1183a2bfadfaaf73 [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>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]79<p class="firstline">Deletes the specified Route resource.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]80<p class="toc_element">
81 <code><a href="#get">get(project, route)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]82<p class="firstline">Returns the specified Route resource. Get a list of available routes by making a list() request.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]83<p class="toc_element">
84 <code><a href="#insert">insert(project, body)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]85<p class="firstline">Creates a Route resource in the specified project using the data included in the request.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]86<p class="toc_element">
87 <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]88<p class="firstline">Retrieves the list of Route resources available to the specified project.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]95 <pre>Deletes the specified Route resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]96
97Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]98 project: string, Project ID for this request. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]99 route: string, Name of the Route resource to delete. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]105 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
106 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]107 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]108 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
109 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
110 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
111 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]112 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]113 "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.
114 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]115 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]116 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
117 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]118 "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]119 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]120 "message": "A String", # [Output Only] A human-readable description of the warning code.
121 "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.
122 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
123 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]124 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]125 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]126 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]127 },
128 ],
129 },
130 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]131 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]132 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
133 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]134 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]135 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]136 "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]137 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]138 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]139 "message": "A String", # [Output Only] An optional, human-readable error message.
140 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]141 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]142 },
143 ],
144 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]145 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]146 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]147 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]148 }</pre>
149</div>
150
151<div class="method">
152 <code class="details" id="get">get(project, route)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]153 <pre>Returns the specified Route resource. Get a list of available routes by making a list() request.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]154
155Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]156 project: string, Project ID for this request. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]157 route: string, Name of the Route resource to return. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]158
159Returns:
160 An object of the form:
161
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]162 { # 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]163 #
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]164 # 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]165 #
166 # Packets that do not match any route in the sending instance's routing table are dropped.
167 "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
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]168 "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]169 "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]170 "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]171 "tags": [ # A list of instance tags to which this route applies.
172 "A String",
173 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]174 "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:
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]175 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]176 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]177 "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]178 "network": "A String", # Fully-qualified URL of the network that this route applies to.
179 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
180 "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]181 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]182 "message": "A String", # [Output Only] A human-readable description of the warning code.
183 "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.
184 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
185 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]186 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]187 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]188 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]189 },
190 ],
191 },
192 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]193 "destRange": "A String", # The destination range of outgoing packets that this route applies to.
194 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]195 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]196 "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]197 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]198 }</pre>
199</div>
200
201<div class="method">
202 <code class="details" id="insert">insert(project, body)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]203 <pre>Creates a Route resource in the specified project using the data included in the request.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]204
205Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]206 project: string, Project ID for this request. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]207 body: object, The request body. (required)
208 The object takes the form of:
209
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]210{ # 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]211 #
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]212 # 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]213 #
214 # Packets that do not match any route in the sending instance's routing table are dropped.
215 "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
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]216 "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]217 "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]218 "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]219 "tags": [ # A list of instance tags to which this route applies.
220 "A String",
221 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]222 "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:
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]223 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]224 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]225 "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]226 "network": "A String", # Fully-qualified URL of the network that this route applies to.
227 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
228 "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]229 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]230 "message": "A String", # [Output Only] A human-readable description of the warning code.
231 "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.
232 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
233 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]234 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]235 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]236 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]237 },
238 ],
239 },
240 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]241 "destRange": "A String", # The destination range of outgoing packets that this route applies to.
242 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]243 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]244 "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]245 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]246 }
247
248
249Returns:
250 An object of the form:
251
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]252 { # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]253 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
254 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]255 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]256 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
257 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
258 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
259 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]260 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]261 "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.
262 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]263 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]264 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
265 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]266 "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]267 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]268 "message": "A String", # [Output Only] A human-readable description of the warning code.
269 "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.
270 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
271 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]272 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]273 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]274 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]275 },
276 ],
277 },
278 ],
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]279 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]280 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
281 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]282 "name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]283 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]284 "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]285 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]286 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]287 "message": "A String", # [Output Only] An optional, human-readable error message.
288 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]289 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]290 },
291 ],
292 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]293 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]294 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]295 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]296 }</pre>
297</div>
298
299<div class="method">
300 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]301 <pre>Retrieves the list of Route resources available to the specified project.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]302
303Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]304 project: string, Project ID for this request. (required)
305 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.
306 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.
307 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]308
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]309The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]310
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]311For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]312
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]313Compute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]314
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]315The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]316
317Returns:
318 An object of the form:
319
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]320 { # Contains a list of Route resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]321 "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.
322 "items": [ # [Output Only] A list of Route resources.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]323 { # 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]324 #
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]325 # 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]326 #
327 # Packets that do not match any route in the sending instance's routing table are dropped.
328 "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
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]329 "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]330 "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]331 "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]332 "tags": [ # A list of instance tags to which this route applies.
333 "A String",
334 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]335 "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:
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]336 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]337 "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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]338 "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]339 "network": "A String", # Fully-qualified URL of the network that this route applies to.
340 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
341 "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]342 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]343 "message": "A String", # [Output Only] A human-readable description of the warning code.
344 "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.
345 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
346 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]347 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]348 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]349 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]350 },
351 ],
352 },
353 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]354 "destRange": "A String", # The destination range of outgoing packets that this route applies to.
355 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]356 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]357 "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]358 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]359 },
360 ],
361 "kind": "compute#routeList", # Type of resource.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]362 "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
363 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]364 }</pre>
365</div>
366
367<div class="method">
368 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
369 <pre>Retrieves the next page of results.
370
371Args:
372 previous_request: The request for the previous page. (required)
373 previous_response: The response from the request for the previous page. (required)
374
375Returns:
376 A request object that you can call 'execute()' on to request the next
377 page. Returns None if there are no more items in the collection.
378 </pre>
379</div>
380
381</body></html>