Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / compute_beta.routes.html
blob: d34e04b93ae41df2ca29c746e75ed9656a16e7d6 [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.routes.html">routes</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]78 <code><a href="#delete">delete(project, route, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Returns the specified Route resource. Gets a list of available routes by making a list() request.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]84 <code><a href="#insert">insert(project, body=None, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]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, orderBy=None, 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<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]93 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]94<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
95<h3>Method Details</h3>
96<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97 <code class="details" id="delete">delete(project, route, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]98 <pre>Deletes the specified Route resource.
99
100Args:
101 project: string, Project ID for this request. (required)
102 route: string, Name of the Route resource to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
104
105For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
106
107The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]108
109Returns:
110 An object of the form:
111
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112 { # Represents an Operation resource.
113 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]114 # Google Compute Engine has three Operation resources:
115 #
116 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
117 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]118 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
119 #
120 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]121 # - For global operations, use the `globalOperations` resource.
122 # - For regional operations, use the `regionOperations` resource.
123 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]125 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]126 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]127 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]128 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]129 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]130 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]131 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]132 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
133 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]134 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]135 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]136 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]137 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]138 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
139 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
140 {
141 "message": "A String", # [Output Only] A human-readable description of the warning code.
142 "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.
143 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
144 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
145 {
146 "value": "A String", # [Output Only] A warning data value corresponding to the key.
147 "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).
148 },
149 ],
150 },
151 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]152 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]153 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]154 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
155 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]156 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]157 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
158 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
159 {
160 "message": "A String", # [Output Only] An optional, human-readable error message.
161 "code": "A String", # [Output Only] The error type identifier for this error.
162 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
163 },
164 ],
165 },
166 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
167 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]168 "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]169 }</pre>
170</div>
171
172<div class="method">
173 <code class="details" id="get">get(project, route)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]174 <pre>Returns the specified Route resource. Gets a list of available routes by making a list() request.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]175
176Args:
177 project: string, Project ID for this request. (required)
178 route: string, Name of the Route resource to return. (required)
179
180Returns:
181 An object of the form:
182
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]183 { # Represents a Route resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]184 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]185 # A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== resource_for {$api_version}.routes ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]186 "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/global/gateways/default-internet-gateway
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]187 "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
188 "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]189 "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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]190 "tags": [ # A list of instance tags to which this route applies.
191 "A String",
192 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]193 "nextHopIlb": "A String", # The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs:
194 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]195 # - regions/region/forwardingRules/forwardingRule
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]196 "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:
197 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]198 "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 cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]199 "nextHopPeering": "A String", # [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]200 "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
201 "network": "A String", # Fully-qualified URL of the network that this route applies to.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]202 "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets. Only IPv4 is supported.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]203 "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
204 {
205 "message": "A String", # [Output Only] A human-readable description of the warning code.
206 "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.
207 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
208 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
209 {
210 "value": "A String", # [Output Only] A warning data value corresponding to the key.
211 "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).
212 },
213 ],
214 },
215 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]216 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]217 "destRange": "A String", # The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]218 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
219 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]220 "nextHopInterconnectAttachment": "A String", # [Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment.
221 "description": "A String", # An optional description of this resource. Provide this field when you create the resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]222 }</pre>
223</div>
224
225<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]226 <code class="details" id="insert">insert(project, body=None, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]227 <pre>Creates a Route resource in the specified project using the data included in the request.
228
229Args:
230 project: string, Project ID for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]231 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]232 The object takes the form of:
233
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]234{ # Represents a Route resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]235 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]236 # A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== resource_for {$api_version}.routes ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]237 "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/global/gateways/default-internet-gateway
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]238 "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
239 "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]240 "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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]241 "tags": [ # A list of instance tags to which this route applies.
242 "A String",
243 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]244 "nextHopIlb": "A String", # The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs:
245 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]246 # - regions/region/forwardingRules/forwardingRule
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]247 "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:
248 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]249 "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 cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]250 "nextHopPeering": "A String", # [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]251 "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
252 "network": "A String", # Fully-qualified URL of the network that this route applies to.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]253 "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets. Only IPv4 is supported.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]254 "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
255 {
256 "message": "A String", # [Output Only] A human-readable description of the warning code.
257 "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.
258 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
259 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
260 {
261 "value": "A String", # [Output Only] A warning data value corresponding to the key.
262 "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).
263 },
264 ],
265 },
266 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]267 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]268 "destRange": "A String", # The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]269 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
270 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]271 "nextHopInterconnectAttachment": "A String", # [Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment.
272 "description": "A String", # An optional description of this resource. Provide this field when you create the resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]273}
274
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]275 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
276
277For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
278
279The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]280
281Returns:
282 An object of the form:
283
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]284 { # Represents an Operation resource.
285 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]286 # Google Compute Engine has three Operation resources:
287 #
288 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
289 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]290 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
291 #
292 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]293 # - For global operations, use the `globalOperations` resource.
294 # - For regional operations, use the `regionOperations` resource.
295 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]296 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]297 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]298 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]299 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]300 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]301 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]302 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]303 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]304 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
305 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]306 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]307 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]308 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]309 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]310 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
311 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
312 {
313 "message": "A String", # [Output Only] A human-readable description of the warning code.
314 "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.
315 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
316 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
317 {
318 "value": "A String", # [Output Only] A warning data value corresponding to the key.
319 "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).
320 },
321 ],
322 },
323 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]324 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]325 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]326 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
327 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]328 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]329 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
330 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
331 {
332 "message": "A String", # [Output Only] An optional, human-readable error message.
333 "code": "A String", # [Output Only] The error type identifier for this error.
334 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
335 },
336 ],
337 },
338 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
339 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]340 "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]341 }</pre>
342</div>
343
344<div class="method">
345 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
346 <pre>Retrieves the list of Route resources available to the specified project.
347
348Args:
349 project: string, Project ID for this request. (required)
350 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
351
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]352You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]353
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]354Currently, only sorting by `name` or `creationTimestamp desc` is supported.
355 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
356 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.
357 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]358
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]359For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]360
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]361You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]362
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]363To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]364
365Returns:
366 An object of the form:
367
368 { # Contains a list of Route resources.
369 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]370 "kind": "compute#routeList", # Type of resource.
371 "items": [ # A list of Route resources.
372 { # Represents a Route resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]373 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]374 # A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== resource_for {$api_version}.routes ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]375 "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/global/gateways/default-internet-gateway
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]376 "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
377 "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]378 "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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]379 "tags": [ # A list of instance tags to which this route applies.
380 "A String",
381 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]382 "nextHopIlb": "A String", # The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs:
383 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]384 # - regions/region/forwardingRules/forwardingRule
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]385 "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:
386 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]387 "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 cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]388 "nextHopPeering": "A String", # [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]389 "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
390 "network": "A String", # Fully-qualified URL of the network that this route applies to.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]391 "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets. Only IPv4 is supported.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]392 "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
393 {
394 "message": "A String", # [Output Only] A human-readable description of the warning code.
395 "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.
396 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
397 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
398 {
399 "value": "A String", # [Output Only] A warning data value corresponding to the key.
400 "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).
401 },
402 ],
403 },
404 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]405 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]406 "destRange": "A String", # The destination range of outgoing packets that this route applies to. Only IPv4 is supported.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]407 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
408 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]409 "nextHopInterconnectAttachment": "A String", # [Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment.
410 "description": "A String", # An optional description of this resource. Provide this field when you create the resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]411 },
412 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]413 "warning": { # [Output Only] Informational warning message.
414 "message": "A String", # [Output Only] A human-readable description of the warning code.
415 "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.
416 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
417 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
418 {
419 "value": "A String", # [Output Only] A warning data value corresponding to the key.
420 "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).
421 },
422 ],
423 },
424 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]425 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
426 }</pre>
427</div>
428
429<div class="method">
430 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
431 <pre>Retrieves the next page of results.
432
433Args:
434 previous_request: The request for the previous page. (required)
435 previous_response: The response from the request for the previous page. (required)
436
437Returns:
438 A request object that you can call 'execute()' on to request the next
439 page. Returns None if there are no more items in the collection.
440 </pre>
441</div>
442
443<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]444 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]445 <pre>Returns permissions that a caller has on the specified resource.
446
447Args:
448 project: string, Project ID for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]449 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]450 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]451 The object takes the form of:
452
453{
454 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
455 "A String",
456 ],
457 }
458
459
460Returns:
461 An object of the form:
462
463 {
464 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
465 "A String",
466 ],
467 }</pre>
468</div>
469
470</body></html>