router_bgp_routes

Creates, updates, deletes, gets or lists a router_bgp_routes resource.

Overview

Name	router_bgp_routes
Type	Resource
Id	google.compute.router_bgp_routes

Fields

The following fields are returned by SELECT queries:

list_bgp_routes

Name	Datatype	Description
id	string	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
etag	string
kind	string	Output only. [Output Only] Type of resource. Alwayscompute#routersListBgpRoutes for lists of bgp routes. (default: compute#routersListBgpRoutes)
nextPageToken	string	[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger thanmaxResults, 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.
result	array	[Output Only] A list of bgp routes.
selfLink	string	Output only. [Output Only] Server-defined URL for this resource.
unreachables	array	Output only. [Output Only] Unreachable resources.
warning	object	[Output Only] Informational warning message.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_bgp_routes	select	project, region, router	peer, addressFamily, filter, pageToken, routeType, returnPartialSuccess, maxResults, destinationPrefix, policyApplied, orderBy	Retrieves a list of router bgp routes available to the specified project.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
project	string
region	string
router	string
addressFamily	string
destinationPrefix	string
filter	string
maxResults	integer (uint32)
orderBy	string
pageToken	string
peer	string
policyApplied	boolean
returnPartialSuccess	boolean
routeType	string

SELECT examples

list_bgp_routes

Retrieves a list of router bgp routes available to the specified project.

SELECT
id,
etag,
kind,
nextPageToken,
result,
selfLink,
unreachables,
warning
FROM google.compute.router_bgp_routes
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND router = '{{ router }}' -- required
AND peer = '{{ peer }}'
AND addressFamily = '{{ addressFamily }}'
AND filter = '{{ filter }}'
AND pageToken = '{{ pageToken }}'
AND routeType = '{{ routeType }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
AND maxResults = '{{ maxResults }}'
AND destinationPrefix = '{{ destinationPrefix }}'
AND policyApplied = '{{ policyApplied }}'
AND orderBy = '{{ orderBy }}'
;