routes

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

Overview

Name	routes
Type	Resource
Id	google.compute.routes

Fields

Name	Datatype	Description
id	string	[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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
description	string	An optional description of this resource. Provide this field when you create the resource.
asPaths	array	[Output Only] AS path.
creationTimestamp	string	[Output Only] Creation timestamp in RFC3339 text format.
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] Type of this resource. Always compute#routes for Route resources.
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] The full resource name of the Network Connectivity Center hub that will handle matching packets.
nextHopIlb	string	The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 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/
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.
nextHopNetwork	string	The URL of the local network if it should handle matching packets.
nextHopPeering	string	[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.
priority	integer	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.
routeType	string	[Output Only] The type of this route, which can be one of the following values: - 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers - 'SUBNET' for a route from a subnet of the VPC - 'BGP' for a route learned from a BGP peer of this router - 'STATIC' for a static route
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] If potential misconfigurations are detected for this route, this field will be populated with warning messages.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	project, route	Returns the specified Route resource.
list	SELECT	project	Retrieves the list of Route resources available to the specified project.
insert	INSERT	project	Creates a Route resource in the specified project using the data included in the request.
delete	DELETE	project, route	Deletes the specified Route resource.

SELECT examples

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

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

INSERT example

Use the following StackQL query and manifest file to create a new routes resource.

All Properties

/*+ create */
INSERT INTO google.compute.routes (
project,
name,
description,
network,
tags,
destRange,
priority,
nextHopInstance,
nextHopIp,
nextHopNetwork,
nextHopGateway,
nextHopPeering,
nextHopIlb,
warnings,
nextHopVpnTunnel,
nextHopHub,
routeType,
asPaths,
routeStatus
)
SELECT 
'{{ project }}',
'{{ name }}',
'{{ description }}',
'{{ network }}',
'{{ tags }}',
'{{ destRange }}',
'{{ priority }}',
'{{ nextHopInstance }}',
'{{ nextHopIp }}',
'{{ nextHopNetwork }}',
'{{ nextHopGateway }}',
'{{ nextHopPeering }}',
'{{ nextHopIlb }}',
'{{ warnings }}',
'{{ nextHopVpnTunnel }}',
'{{ nextHopHub }}',
'{{ routeType }}',
'{{ asPaths }}',
'{{ routeStatus }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: kind
      value: string
    - name: id
      value: string
    - name: creationTimestamp
      value: string
    - name: name
      value: string
    - name: description
      value: string
    - name: network
      value: string
    - name: tags
      value:
        - string
    - name: destRange
      value: string
    - name: priority
      value: integer
    - name: nextHopInstance
      value: string
    - name: nextHopIp
      value: string
    - name: nextHopNetwork
      value: string
    - name: nextHopGateway
      value: string
    - name: nextHopPeering
      value: string
    - name: nextHopIlb
      value: string
    - name: warnings
      value:
        - - name: code
            value: string
          - name: message
            value: string
          - name: data
            value:
              - - name: key
                  value: string
                - name: value
                  value: string
    - name: nextHopVpnTunnel
      value: string
    - name: nextHopHub
      value: string
    - name: selfLink
      value: string
    - name: routeType
      value: string
    - name: asPaths
      value:
        - - name: pathSegmentType
            value: string
          - name: asLists
            value:
              - integer
    - name: routeStatus
      value: string

DELETE example

Deletes the specified routes resource.

/*+ delete */
DELETE FROM google.compute.routes
WHERE project = '{{ project }}'
AND route = '{{ route }}';