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