routes

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

Overview

Name	`routes`
Type	Resource
Id	`google.compute.routes`

Fields

The following fields are returned by SELECT queries:

get
list

Name	Datatype	Description
`id`	`string (uint64)`	Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`name`	`string`	Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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. (pattern: `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`)
`asPaths`	`array`	Output only. [Output Only] AS path.
`creationTimestamp`	`string`	Output only. [Output Only] Creation timestamp inRFC3339 text format.
`description`	`string`	An optional description of this resource. Provide this field when you create the resource.
`destRange`	`string`	The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported. Must specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291 format (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952 compressed format.
`kind`	`string`	Output only. [Output Only] Type of this resource. Always compute#routes for Route resources. (default: compute#route)
`network`	`string`	Fully-qualified URL of the network that this route applies to.
`nextHopGateway`	`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
`nextHopHub`	`string`	Output only. [Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets.
`nextHopIlb`	`string`	The URL to a forwarding rule of typeloadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule If an IP address is provided, must specify an IPv4 address in dot-decimal notation or an IPv6 address in RFC 4291 format. For example, the following are all valid IP addresses: - 10.128.0.56 - 2001:db8::2d9:51:0:0 - 2001:db8:0:0:2d9:51:0:0 IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.
`nextHopInstance`	`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/
`nextHopInterRegionCost`	`integer (uint32)`	Output only. [Output only] Internal fixed region-to-region cost that Google Cloud calculates based on factors such as network performance, distance, and available bandwidth between regions.
`nextHopInterconnectAttachment`	`string`	Output only. [Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for dynamic routes generated by Cloud Router with a linked interconnectAttachment or the static route generated by each L2 Interconnect Attachment.
`nextHopIp`	`string`	The network IP address of an instance that should handle matching packets. Both IPv6 address and IPv4 addresses are supported. Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.
`nextHopMed`	`integer (uint32)`	Output only. [Output Only] Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.
`nextHopNetwork`	`string`	The URL of the local network if it should handle matching packets.
`nextHopOrigin`	`string`	Output only. [Output Only] Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE. (EGP, IGP, INCOMPLETE)
`nextHopPeering`	`string`	Output only. [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.
`nextHopVpnTunnel`	`string`	The URL to a VpnTunnel that should handle matching packets.
`params`	`object`	Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. (id: RouteParams)
`priority`	`integer (uint32)`	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.
`routeStatus`	`string`	[Output only] The status of the route. This status applies to dynamic routes learned by Cloud Routers. It is also applicable to routes undergoing migration. (ACTIVE, DROPPED, INACTIVE, PENDING)
`routeType`	`string`	Output only. [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 (BGP, STATIC, SUBNET, TRANSIT)
`selfLink`	`string`	[Output Only] Server-defined fully-qualified URL for this resource.
`tags`	`array`	A list of instance tags to which this route applies.
`warnings`	`array`	Output only. [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.

Name	Datatype	Description
`id`	`string`	[Output Only] Unique identifier for the resource; defined by the server.
`items`	`array`	A list of Route resources.
`kind`	`string`	Output only. Type of resource. (default: compute#routeList)
`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.
`selfLink`	`string`	Output only. [Output Only] Server-defined URL for this resource.
`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`	`select`	`project`, `route`		Returns the specified Route resource.
`list`	`select`	`project`	`returnPartialSuccess`, `orderBy`, `maxResults`, `pageToken`, `filter`	Retrieves the list of Route resources available to the specified project.
`insert`	`insert`	`project`	`requestId`	Creates a Route resource in the specified project using the data included in the request.
`delete`	`delete`	`project`, `route`	`requestId`	Deletes the specified Route resource.

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

`SELECT` examples

get
list

Returns the specified Route resource.

SELECT
id,
name,
asPaths,
creationTimestamp,
description,
destRange,
kind,
network,
nextHopGateway,
nextHopHub,
nextHopIlb,
nextHopInstance,
nextHopInterRegionCost,
nextHopInterconnectAttachment,
nextHopIp,
nextHopMed,
nextHopNetwork,
nextHopOrigin,
nextHopPeering,
nextHopVpnTunnel,
params,
priority,
routeStatus,
routeType,
selfLink,
tags,
warnings
FROM google.compute.routes
WHERE project = '{{ project }}' -- required
AND route = '{{ route }}' -- required
;

Retrieves the list of Route resources available to the specified project.

SELECT
id,
items,
kind,
nextPageToken,
selfLink,
warning
FROM google.compute.routes
WHERE project = '{{ project }}' -- required
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
AND orderBy = '{{ orderBy }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
;

`INSERT` examples

insert
Manifest

Creates a Route resource in the specified project using the data included
in the request.

INSERT INTO google.compute.routes (
data__description,
data__nextHopIlb,
data__routeStatus,
data__name,
data__priority,
data__nextHopInstance,
data__nextHopNetwork,
data__selfLink,
data__nextHopIp,
data__destRange,
data__params,
data__nextHopGateway,
data__tags,
data__network,
data__nextHopVpnTunnel,
project,
requestId
)
SELECT 
'{{ description }}',
'{{ nextHopIlb }}',
'{{ routeStatus }}',
'{{ name }}',
{{ priority }},
'{{ nextHopInstance }}',
'{{ nextHopNetwork }}',
'{{ selfLink }}',
'{{ nextHopIp }}',
'{{ destRange }}',
'{{ params }}',
'{{ nextHopGateway }}',
'{{ tags }}',
'{{ network }}',
'{{ nextHopVpnTunnel }}',
'{{ project }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

# Description fields are for documentation purposes
- name: routes
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the routes resource.
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of this resource. Provide this field when you
      create the resource.
  - name: nextHopIlb
    value: "{{ nextHopIlb }}"
    description: |
      The URL to a forwarding rule of typeloadBalancingScheme=INTERNAL that should handle matching
      packets or the IP address of the forwarding Rule.
      For example, the following are all valid URLs:
      - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule
      - regions/region/forwardingRules/forwardingRule
      If an IP address is provided, must specify an IPv4 address in dot-decimal
      notation or an IPv6 address in RFC 4291 format. For example, the following
      are all valid IP addresses:
      - 10.128.0.56
      - 2001:db8::2d9:51:0:0
      - 2001:db8:0:0:2d9:51:0:0
      IPv6 addresses will be displayed using RFC 5952 compressed format (e.g.
      2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.
  - name: routeStatus
    value: "{{ routeStatus }}"
    description: |
      [Output only] The status of the route. This status applies to
      dynamic routes learned by Cloud Routers. It is also applicable to routes
      undergoing migration.
    valid_values: ['ACTIVE', 'DROPPED', 'INACTIVE', 'PENDING']
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource. Provided by the client when the resource is created.
      The name must be 1-63 characters long, and comply withRFC1035.
      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.
  - name: priority
    value: {{ priority }}
    description: |
      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.
  - name: nextHopInstance
    value: "{{ nextHopInstance }}"
    description: |
      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/
  - name: nextHopNetwork
    value: "{{ nextHopNetwork }}"
    description: |
      The URL of the local network if it should handle matching packets.
  - name: selfLink
    value: "{{ selfLink }}"
    description: |
      [Output Only] Server-defined fully-qualified URL for this resource.
  - name: nextHopIp
    value: "{{ nextHopIp }}"
    description: |
      The network IP address of an instance that should handle matching packets.
      Both IPv6 address and IPv4 addresses are supported.
      Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or
      an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or
      2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952
      compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an
      IPv4-mapped IPv6 address.
  - name: destRange
    value: "{{ destRange }}"
    description: |
      The destination range of outgoing packets that this route applies to. Both
      IPv4 and IPv6 are supported.
      Must specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291
      format (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952
      compressed format.
  - name: params
    description: |
      Input only. [Input Only] Additional params passed with the request, but not persisted
      as part of resource payload.
    value:
      resourceManagerTags: "{{ resourceManagerTags }}"
  - name: nextHopGateway
    value: "{{ nextHopGateway }}"
    description: |
      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
  - name: tags
    value:
      - "{{ tags }}"
    description: |
      A list of instance tags to which this route applies.
  - name: network
    value: "{{ network }}"
    description: |
      Fully-qualified URL of the network that this route applies to.
  - name: nextHopVpnTunnel
    value: "{{ nextHopVpnTunnel }}"
    description: |
      The URL to a VpnTunnel that should handle matching packets.
  - name: requestId
    value: "{{ requestId }}"

`DELETE` examples

delete

Deletes the specified Route resource.

DELETE FROM google.compute.routes
WHERE project = '{{ project }}' --required
AND route = '{{ route }}' --required
AND requestId = '{{ requestId }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

DELETE examples​