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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.routes.html">routes</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(project, route, requestId=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes the specified Route resource.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(project, route, x__xgafv=None)</a></code></p> 85<p class="firstline">Returns the specified Route resource. Gets a list of available routes by making a list() request.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Creates a Route resource in the specified project using the data included in the request.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Retrieves the list of Route resources available to the specified project.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="delete">delete(project, route, requestId=None, x__xgafv=None)</code> 106 <pre>Deletes the specified Route resource. 107 108Args: 109 project: string, Project ID for this request. (required) 110 route: string, Name of the Route resource to delete. (required) 111 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 112 x__xgafv: string, V1 error format. 113 Allowed values 114 1 - v1 error format 115 2 - v2 error format 116 117Returns: 118 An object of the form: 119 120 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 121 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 122 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 123 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 124 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 125 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 126 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 127 { 128 "code": "A String", # [Output Only] The error type identifier for this error. 129 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 130 "message": "A String", # [Output Only] An optional, human-readable error message. 131 }, 132 ], 133 }, 134 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 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. 136 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 137 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 138 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 139 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 140 "a_key": "", # Properties of the object. Contains field @type with type URL. 141 }, 142 "name": "A String", # [Output Only] Name of the operation. 143 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 144 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 145 "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. 146 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 147 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 148 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 149 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 150 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 151 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 152 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 153 "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. 154 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 155 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 156 { 157 "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. 158 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 159 { 160 "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). 161 "value": "A String", # [Output Only] A warning data value corresponding to the key. 162 }, 163 ], 164 "message": "A String", # [Output Only] A human-readable description of the warning code. 165 }, 166 ], 167 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 168}</pre> 169</div> 170 171<div class="method"> 172 <code class="details" id="get">get(project, route, x__xgafv=None)</code> 173 <pre>Returns the specified Route resource. Gets a list of available routes by making a list() request. 174 175Args: 176 project: string, Project ID for this request. (required) 177 route: string, Name of the Route resource to return. (required) 178 x__xgafv: string, V1 error format. 179 Allowed values 180 1 - v1 error format 181 2 - v2 error format 182 183Returns: 184 An object of the form: 185 186 { # Represents a Route resource. 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. 187 "allowConflictingSubnetworks": True or False, # Whether this route can conflict with existing subnetworks. Setting this to true allows this route to conflict with subnetworks that have already been configured on the corresponding network. 188 "asPaths": [ # [Output Only] AS path. 189 { 190 "asLists": [ # [Output Only] The AS numbers of the AS Path. 191 42, 192 ], 193 "pathSegmentType": "A String", # [Output Only] The type of the AS Path, which can be one of the following values: - 'AS_SET': unordered set of autonomous systems that the route in has traversed - 'AS_SEQUENCE': ordered set of autonomous systems that the route has traversed - 'AS_CONFED_SEQUENCE': ordered set of Member Autonomous Systems in the local confederation that the route has traversed - 'AS_CONFED_SET': unordered set of Member Autonomous Systems in the local confederation that the route has traversed 194 }, 195 ], 196 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 197 "description": "A String", # An optional description of this resource. Provide this field when you create the resource. 198 "destRange": "A String", # The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported. 199 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 200 "ilbRouteBehaviorOnUnhealthy": "A String", # ILB route behavior when ILB is deemed unhealthy based on user specified threshold on the Backend Service of the internal load balancing. 201 "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources. 202 "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. 203 "network": "A String", # Fully-qualified URL of the network that this route applies to. 204 "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 205 "nextHopIlb": "A String", # The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule 206 "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: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ 207 "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. 208 "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets. Only IPv4 is supported. 209 "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets. 210 "nextHopPeering": "A String", # [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035. 211 "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets. 212 "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. 213 "routeType": "A String", # [Output Only] The type of this route, which can be one of the following values: - 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers - 'SUBNET' for a route from a subnet of the VPC - 'BGP' for a route learned from a BGP peer of this router - 'STATIC' for a static route 214 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. 215 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 216 "tags": [ # A list of instance tags to which this route applies. 217 "A String", 218 ], 219 "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages. 220 { 221 "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. 222 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 223 { 224 "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). 225 "value": "A String", # [Output Only] A warning data value corresponding to the key. 226 }, 227 ], 228 "message": "A String", # [Output Only] A human-readable description of the warning code. 229 }, 230 ], 231}</pre> 232</div> 233 234<div class="method"> 235 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code> 236 <pre>Creates a Route resource in the specified project using the data included in the request. 237 238Args: 239 project: string, Project ID for this request. (required) 240 body: object, The request body. 241 The object takes the form of: 242 243{ # Represents a Route resource. 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. 244 "allowConflictingSubnetworks": True or False, # Whether this route can conflict with existing subnetworks. Setting this to true allows this route to conflict with subnetworks that have already been configured on the corresponding network. 245 "asPaths": [ # [Output Only] AS path. 246 { 247 "asLists": [ # [Output Only] The AS numbers of the AS Path. 248 42, 249 ], 250 "pathSegmentType": "A String", # [Output Only] The type of the AS Path, which can be one of the following values: - 'AS_SET': unordered set of autonomous systems that the route in has traversed - 'AS_SEQUENCE': ordered set of autonomous systems that the route has traversed - 'AS_CONFED_SEQUENCE': ordered set of Member Autonomous Systems in the local confederation that the route has traversed - 'AS_CONFED_SET': unordered set of Member Autonomous Systems in the local confederation that the route has traversed 251 }, 252 ], 253 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 254 "description": "A String", # An optional description of this resource. Provide this field when you create the resource. 255 "destRange": "A String", # The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported. 256 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 257 "ilbRouteBehaviorOnUnhealthy": "A String", # ILB route behavior when ILB is deemed unhealthy based on user specified threshold on the Backend Service of the internal load balancing. 258 "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources. 259 "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. 260 "network": "A String", # Fully-qualified URL of the network that this route applies to. 261 "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 262 "nextHopIlb": "A String", # The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule 263 "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: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ 264 "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. 265 "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets. Only IPv4 is supported. 266 "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets. 267 "nextHopPeering": "A String", # [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035. 268 "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets. 269 "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. 270 "routeType": "A String", # [Output Only] The type of this route, which can be one of the following values: - 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers - 'SUBNET' for a route from a subnet of the VPC - 'BGP' for a route learned from a BGP peer of this router - 'STATIC' for a static route 271 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. 272 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 273 "tags": [ # A list of instance tags to which this route applies. 274 "A String", 275 ], 276 "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages. 277 { 278 "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. 279 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 280 { 281 "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). 282 "value": "A String", # [Output Only] A warning data value corresponding to the key. 283 }, 284 ], 285 "message": "A String", # [Output Only] A human-readable description of the warning code. 286 }, 287 ], 288} 289 290 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 291 x__xgafv: string, V1 error format. 292 Allowed values 293 1 - v1 error format 294 2 - v2 error format 295 296Returns: 297 An object of the form: 298 299 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 300 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 301 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 302 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 303 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 304 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 305 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 306 { 307 "code": "A String", # [Output Only] The error type identifier for this error. 308 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 309 "message": "A String", # [Output Only] An optional, human-readable error message. 310 }, 311 ], 312 }, 313 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 314 "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. 315 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 316 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 317 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 318 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 319 "a_key": "", # Properties of the object. Contains field @type with type URL. 320 }, 321 "name": "A String", # [Output Only] Name of the operation. 322 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 323 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 324 "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. 325 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 326 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 327 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 328 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 329 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 330 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 331 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 332 "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. 333 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 334 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 335 { 336 "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. 337 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 338 { 339 "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). 340 "value": "A String", # [Output Only] A warning data value corresponding to the key. 341 }, 342 ], 343 "message": "A String", # [Output Only] A human-readable description of the warning code. 344 }, 345 ], 346 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 347}</pre> 348</div> 349 350<div class="method"> 351 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 352 <pre>Retrieves the list of Route resources available to the specified project. 353 354Args: 355 project: string, Project ID for this request. (required) 356 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You 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. To 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) ``` 357 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`) 358 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 359 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. 360 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 361 x__xgafv: string, V1 error format. 362 Allowed values 363 1 - v1 error format 364 2 - v2 error format 365 366Returns: 367 An object of the form: 368 369 { # Contains a list of Route resources. 370 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 371 "items": [ # A list of Route resources. 372 { # Represents a Route resource. 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. 373 "allowConflictingSubnetworks": True or False, # Whether this route can conflict with existing subnetworks. Setting this to true allows this route to conflict with subnetworks that have already been configured on the corresponding network. 374 "asPaths": [ # [Output Only] AS path. 375 { 376 "asLists": [ # [Output Only] The AS numbers of the AS Path. 377 42, 378 ], 379 "pathSegmentType": "A String", # [Output Only] The type of the AS Path, which can be one of the following values: - 'AS_SET': unordered set of autonomous systems that the route in has traversed - 'AS_SEQUENCE': ordered set of autonomous systems that the route has traversed - 'AS_CONFED_SEQUENCE': ordered set of Member Autonomous Systems in the local confederation that the route has traversed - 'AS_CONFED_SET': unordered set of Member Autonomous Systems in the local confederation that the route has traversed 380 }, 381 ], 382 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 383 "description": "A String", # An optional description of this resource. Provide this field when you create the resource. 384 "destRange": "A String", # The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported. 385 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 386 "ilbRouteBehaviorOnUnhealthy": "A String", # ILB route behavior when ILB is deemed unhealthy based on user specified threshold on the Backend Service of the internal load balancing. 387 "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources. 388 "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. 389 "network": "A String", # Fully-qualified URL of the network that this route applies to. 390 "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 391 "nextHopIlb": "A String", # The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule 392 "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: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ 393 "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. 394 "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets. Only IPv4 is supported. 395 "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets. 396 "nextHopPeering": "A String", # [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035. 397 "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets. 398 "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. 399 "routeType": "A String", # [Output Only] The type of this route, which can be one of the following values: - 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers - 'SUBNET' for a route from a subnet of the VPC - 'BGP' for a route learned from a BGP peer of this router - 'STATIC' for a static route 400 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. 401 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 402 "tags": [ # A list of instance tags to which this route applies. 403 "A String", 404 ], 405 "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages. 406 { 407 "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. 408 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 409 { 410 "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). 411 "value": "A String", # [Output Only] A warning data value corresponding to the key. 412 }, 413 ], 414 "message": "A String", # [Output Only] A human-readable description of the warning code. 415 }, 416 ], 417 }, 418 ], 419 "kind": "compute#routeList", # Type of resource. 420 "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. 421 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 422 "warning": { # [Output Only] Informational warning message. 423 "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. 424 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 425 { 426 "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). 427 "value": "A String", # [Output Only] A warning data value corresponding to the key. 428 }, 429 ], 430 "message": "A String", # [Output Only] A human-readable description of the warning code. 431 }, 432}</pre> 433</div> 434 435<div class="method"> 436 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 437 <pre>Retrieves the next page of results. 438 439Args: 440 previous_request: The request for the previous page. (required) 441 previous_response: The response from the request for the previous page. (required) 442 443Returns: 444 A request object that you can call 'execute()' on to request the next 445 page. Returns None if there are no more items in the collection. 446 </pre> 447</div> 448 449<div class="method"> 450 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code> 451 <pre>Returns permissions that a caller has on the specified resource. 452 453Args: 454 project: string, Project ID for this request. (required) 455 resource: string, Name or id of the resource for this request. (required) 456 body: object, The request body. 457 The object takes the form of: 458 459{ 460 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 461 "A String", 462 ], 463} 464 465 x__xgafv: string, V1 error format. 466 Allowed values 467 1 - v1 error format 468 2 - v2 error format 469 470Returns: 471 An object of the form: 472 473 { 474 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 475 "A String", 476 ], 477}</pre> 478</div> 479 480</body></html>