route_policies

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

Overview

Name	route_policies
Type	Resource
Id	google.compute.route_policies

Fields

The following fields are returned by SELECT queries:

get_route_policy

Successful response

Name	Datatype	Description
resource	object	(id: RoutePolicy)

list_route_policies

Successful response

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] Type of resource. Always compute#routersListRoutePolicies for lists of route policies. (default: compute#routersListRoutePolicies)
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 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.
result	array	[Output Only] A list of route policies.
selfLink	string	[Output Only] Server-defined URL for this resource.
unreachables	array	[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
get_route_policy	select	project, region, router	policy	Returns specified Route Policy
list_route_policies	select	project, region, router	filter, maxResults, orderBy, pageToken, returnPartialSuccess	Retrieves a list of router route policy subresources available to the specified project.
update_route_policy	update	project, region, router	requestId	Updates or creates new Route Policy
delete_route_policy	delete	project, region, router	policy, requestId	Deletes Route Policy

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
filter	string
maxResults	integer (uint32)
orderBy	string
pageToken	string
policy	string
requestId	string
returnPartialSuccess	boolean

SELECT examples

get_route_policy

Returns specified Route Policy

SELECT
resource
FROM google.compute.route_policies
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND router = '{{ router }}' -- required
AND policy = '{{ policy }}';

list_route_policies

Retrieves a list of router route policy subresources available to the specified project.

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

UPDATE examples

update_route_policy

Updates or creates new Route Policy

UPDATE google.compute.route_policies
SET 
data__name = '{{ name }}',
data__type = '{{ type }}',
data__terms = '{{ terms }}',
data__fingerprint = '{{ fingerprint }}',
data__description = '{{ description }}'
WHERE 
project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND router = '{{ router }}' --required
AND requestId = '{{ requestId}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;

DELETE examples

delete_route_policy

Deletes Route Policy

DELETE FROM google.compute.route_policies
WHERE project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND router = '{{ router }}' --required
AND policy = '{{ policy }}'
AND requestId = '{{ requestId }}';